bibliothek.gui.dock.frontend
Interface FrontendEntry

All Known Implementing Classes:

DockFrontend.DockInfo

public interface FrontendEntry

A bag of information about a Dockable that might be registered at a DockFrontend.

Author:

Benjamin Sigg

Method Summary

Dockable	getDockable() The element for which this object stores information.
java.lang.String	getKey() The name which is used for this object.
DockLayoutComposition	getLayout() Gets information about the layout of this element.
DockableProperty	getLocation() Gets the location of the element which it had the last time it was made invisible.
java.lang.String	getRoot() Gets the name of the station on which the element was the last time when it was made invisible.
boolean	isEntryLayout() If set, then every entry Setting can change the layout of this element.
boolean	isHideable() Tells whether to show a "close"-action for the dockable or not.
boolean	isShown() Tells whether this infos dockable should be shown.
void	setEntryLayout(boolean entryLayout) If set, then every entry Setting can change the layout of this element.
void	setHideable(boolean hideable) Sets whether the element can be made invisible or not.
void	setLayout(DockLayoutComposition layout) Sets information about the layout of this element.
void	setLocation(java.lang.String root, DockableProperty location) Sets the location of the element.
void	setShown(boolean shown) Sets whether the dockable of this entry should be shown or not.

Method Detail

setShown

void setShown(boolean shown)

Sets whether the dockable of this entry should be shown or not. Note that this method will not change any state of the dockable, it only stores a hint.

Parameters:

shown - whether the element should be shown

isShown

boolean isShown()

Tells whether this infos dockable should be shown. Note that this is only a hint, not the actual state.

Returns:

whether this element should be shown

isEntryLayout

boolean isEntryLayout()

If set, then every entry Setting can change the layout of this element.

Returns:

true if the layout of this element should be stored always.

setEntryLayout

void setEntryLayout(boolean entryLayout)

If set, then every entry Setting can change the layout of this element.

Parameters:

entryLayout - if the layout of this element should be stored always.

isHideable

boolean isHideable()

Tells whether to show a "close"-action for the dockable or not.

Returns:

true if the element can be made invisible.

setHideable

void setHideable(boolean hideable)

Sets whether the element can be made invisible or not. This method will have an immediate effect.

Parameters:

hideable - the new state

getDockable

Dockable getDockable()

The element for which this object stores information.

Returns:

the element, can be null

getKey

java.lang.String getKey()

The name which is used for this object.

Returns:

the name

setLocation

void setLocation(java.lang.String root,
                 DockableProperty location)

Sets the location of the element. Note that this method will have no effect if the dockable is currently shown.

Parameters:

root - the root, might be null

location - the location, might be null

getRoot

java.lang.String getRoot()

Gets the name of the station on which the element was the last time when it was made invisible.

Returns:

the name or null

getLocation

DockableProperty getLocation()

Gets the location of the element which it had the last time it was made invisible.

Returns:

the location or null

setLayout

void setLayout(DockLayoutComposition layout)

Sets information about the layout of this element. Note: this is only a hint and might only be applied if the dockable of this entry is currently missing and added later.

Parameters:

layout - the layout, can be null

getLayout

DockLayoutComposition getLayout()

Gets information about the layout of this element.

Returns:

the information, might be null