oracle.ide.layout
Interface LayoutSelector

All Known Implementing Classes:

AbstractEditor, AbstractFlatEditor, AbstractMergeEditor, oracle.jdevimpl.compare.BaseCompareEditor, CodeEditor, Editor, FlatEditor, oracle.jdevimpl.history.HistoryViewer, TextMergeEditor, UIEditor, VersionHistoryViewer

public interface LayoutSelector

LayoutSelector interface. Views that want to select a preferred layout when activated should implement this interface.

Method Summary

void	addPreferredLayoutListener(PreferredLayoutListener l) Add a PreferredLayoutListener.
java.lang.String	getDisplayName() Returns a visible name that describes the class implementing this interface.
java.lang.String	getPreferredLayoutBaseName() Returns the base name is used as the file name part when building the preferred layout URL.
java.net.URL	getPreferredLayoutURL() Implementations should override this method and return their preferred layout.
java.lang.String	getType() Return a string that uniquely identifies this selector.
void	initializeActiveLayout() This method is called immediate after activating the selector's preferred layout.
void	initializeLayout(Layout layout) This method is called before to activate the selector's preferred layout.
boolean	isReady() This method is called before a preferred layout is activated.
void	removePreferredLayoutListener(PreferredLayoutListener l) Remvoe a PreferredLayoutListener.
void	setPreferredLayoutBaseName(java.lang.String name) Set the base name is used as the file name part when building the preferred layout URL.
void	setPreferredLayoutURL(java.net.URL layoutURL) This method is called from the activatePreferredLayout method to record a layout chosen by the user as their preferred layout.
void	setType(java.lang.String type) Set a string that uniquely identifies this selector.

Method Detail

getPreferredLayoutURL

java.net.URL getPreferredLayoutURL()

Implementations should override this method and return their preferred layout. This method is called from the activatePreferredLayout method to determine if this selector has a preferred layout. Default implementation returns null indicating that the selector does not have a preferred layout.

setPreferredLayoutURL

void setPreferredLayoutURL(java.net.URL layoutURL)

This method is called from the activatePreferredLayout method to record a layout chosen by the user as their preferred layout.

initializeLayout

void initializeLayout(Layout layout)

This method is called before to activate the selector's preferred layout. This is the opportunity for the layout selector to set values that will distinct its layout from others.

initializeActiveLayout

void initializeActiveLayout()

This method is called immediate after activating the selector's preferred layout.

isReady

boolean isReady()

This method is called before a preferred layout is activated. This method should return true only when the selector is visible and fully activated.

getDisplayName

java.lang.String getDisplayName()

Returns a visible name that describes the class implementing this interface.

getType

java.lang.String getType()

Return a string that uniquely identifies this selector. Selectors of the same type use the same preferred layout.

setType

void setType(java.lang.String type)

Set a string that uniquely identifies this selector. Selectors of the same type use the same preferred layout.

getPreferredLayoutBaseName

java.lang.String getPreferredLayoutBaseName()

Returns the base name is used as the file name part when building the preferred layout URL.

setPreferredLayoutBaseName

void setPreferredLayoutBaseName(java.lang.String name)

Set the base name is used as the file name part when building the preferred layout URL.

addPreferredLayoutListener

void addPreferredLayoutListener(PreferredLayoutListener l)

Add a PreferredLayoutListener.

removePreferredLayoutListener

void removePreferredLayoutListener(PreferredLayoutListener l)

Remvoe a PreferredLayoutListener.