com.alee.managers.settings.processors

Class WebDocumentPaneSettingsProcessor

java.lang.Object

com.alee.managers.settings.SettingsProcessor<WebDocumentPane,DocumentPaneState>

com.alee.managers.settings.processors.WebDocumentPaneSettingsProcessor

All Implemented Interfaces:

DocumentListener, DocumentPaneListener, java.util.EventListener

public class WebDocumentPaneSettingsProcessor
extends com.alee.managers.settings.SettingsProcessor<WebDocumentPane,DocumentPaneState>
implements DocumentListener, DocumentPaneListener

Custom SettingsProcessor for WebDocumentPane component.

See Also:

How to use SettingsManager, SettingsManager, SettingsProcessor

Field Summary

Fields inherited from class com.alee.managers.settings.SettingsProcessor

data, loading, saving

Constructor Summary

Constructors

Constructor and Description
WebDocumentPaneSettingsProcessor(com.alee.managers.settings.SettingsProcessorData data) Constructs SettingsProcessor using the specified SettingsProcessorData.

Method Summary

Modifier and Type	Method and Description
void	closed(DocumentData document, PaneData pane, int index) Informs that provided document is closed.
boolean	closing(DocumentData document, PaneData pane, int index) Informs that provided document is being closed.
void	dividerLocationChanged(WebDocumentPane documentPane, SplitData splitData) Informs that specified SplitData's divider location has changed.
protected void	doDestroy(WebDocumentPane component)
protected void	doInit(WebDocumentPane component)
protected void	doLoad(WebDocumentPane component)
protected void	doSave(WebDocumentPane component)
void	merged(WebDocumentPane documentPane, SplitData mergedSplit, StructureData newStructureData) Informs that specified SplitData was merged.
void	opened(DocumentData document, PaneData pane, int index) Informs that provided document was opened inside document pane.
void	orientationChanged(WebDocumentPane documentPane, SplitData splitData) Informs that specified SplitData's orientation was changed.
void	selected(DocumentData document, PaneData pane, int index) Informs that provided document was selected inside document pane.
void	sidesSwapped(WebDocumentPane documentPane, SplitData splitData) Informs that specified SplitData's sides were swapped.
void	splitted(WebDocumentPane documentPane, PaneData splittedPane, SplitData newSplitData) Informs that specified PaneData was splitted.

Methods inherited from class com.alee.managers.settings.SettingsProcessor

destroy, getComponent, getData, getDefaultValue, getGroup, getKey, load, loadValue, save, save, saveValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebDocumentPaneSettingsProcessor

public WebDocumentPaneSettingsProcessor(com.alee.managers.settings.SettingsProcessorData data)

Constructs SettingsProcessor using the specified SettingsProcessorData.

Parameters:

data - SettingsProcessorData

Method Detail

doInit

protected void doInit(WebDocumentPane component)

Specified by:

doInit in class com.alee.managers.settings.SettingsProcessor<WebDocumentPane,DocumentPaneState>

doDestroy

protected void doDestroy(WebDocumentPane component)

Specified by:

doDestroy in class com.alee.managers.settings.SettingsProcessor<WebDocumentPane,DocumentPaneState>

opened

public void opened(DocumentData document,
                   PaneData pane,
                   int index)

Description copied from interface: DocumentListener

Informs that provided document was opened inside document pane.

Specified by:

opened in interface DocumentListener

Parameters:

document - document data

pane - specific document pane

index - document tab index

selected

public void selected(DocumentData document,
                     PaneData pane,
                     int index)

Description copied from interface: DocumentListener

Informs that provided document was selected inside document pane. This will also occur when changing focus between panes in split mode as there is only one selected document at a time.

Specified by:

selected in interface DocumentListener

Parameters:

document - document data

pane - specific document pane

index - document tab index

closing

public boolean closing(DocumentData document,
                       PaneData pane,
                       int index)

Description copied from interface: DocumentListener

Informs that provided document is being closed. Returns whether document is allowed to close or not.

Specified by:

closing in interface DocumentListener

Parameters:

document - document data

pane - specific document pane

index - document tab index

Returns:

true if document is allowed to close, false otherwise

closed

public void closed(DocumentData document,
                   PaneData pane,
                   int index)

Description copied from interface: DocumentListener

Informs that provided document is closed.

Specified by:

closed in interface DocumentListener

Parameters:

document - document data

pane - specific document pane

index - document tab index

splitted

public void splitted(WebDocumentPane documentPane,
                     PaneData splittedPane,
                     SplitData newSplitData)

Description copied from interface: DocumentPaneListener

Informs that specified PaneData was splitted.

Specified by:

splitted in interface DocumentPaneListener

Parameters:

documentPane - WebDocumentPane

splittedPane - splitted PaneData

newSplitData - newly created SplitData

merged

public void merged(WebDocumentPane documentPane,
                   SplitData mergedSplit,
                   StructureData newStructureData)

Description copied from interface: DocumentPaneListener

Informs that specified SplitData was merged.

Specified by:

merged in interface DocumentPaneListener

Parameters:

documentPane - WebDocumentPane

mergedSplit - merged SplitData

newStructureData - newly created StructureData

orientationChanged

public void orientationChanged(WebDocumentPane documentPane,
                               SplitData splitData)

Description copied from interface: DocumentPaneListener

Informs that specified SplitData's orientation was changed.

Specified by:

orientationChanged in interface DocumentPaneListener

Parameters:

documentPane - WebDocumentPane

splitData - SplitData which orientation has changed

sidesSwapped

public void sidesSwapped(WebDocumentPane documentPane,
                         SplitData splitData)

Description copied from interface: DocumentPaneListener

Informs that specified SplitData's sides were swapped.

Specified by:

sidesSwapped in interface DocumentPaneListener

Parameters:

documentPane - WebDocumentPane

splitData - SplitData which sides were swapped

dividerLocationChanged

public void dividerLocationChanged(WebDocumentPane documentPane,
                                   SplitData splitData)

Description copied from interface: DocumentPaneListener

Informs that specified SplitData's divider location has changed.

Specified by:

dividerLocationChanged in interface DocumentPaneListener

Parameters:

documentPane - WebDocumentPane

splitData - SplitData which divider location has changed

doLoad

protected void doLoad(WebDocumentPane component)

Specified by:

doLoad in class com.alee.managers.settings.SettingsProcessor<WebDocumentPane,DocumentPaneState>

doSave

protected void doSave(WebDocumentPane component)

Specified by:

doSave in class com.alee.managers.settings.SettingsProcessor<WebDocumentPane,DocumentPaneState>