org.drombler.commons.docking.fx

Class FXDockableData

java.lang.Object

org.drombler.commons.docking.fx.FXDockableData

All Implemented Interfaces:

DockableData

public class FXDockableData
extends Object
implements DockableData

Data about a Dockable.

Author:

puce

Property Summary

Type	Property and Description
ObjectProperty<ContextMenu>	contextMenu The ContextMenu.
ObjectProperty<GraphicFactory>	graphicFactory The GraphicFactory.
ObjectProperty<Node>	graphic The graphic of this Dockable.
BooleanProperty	modified The modified flag indicates if the data represented by the Dockable has been modified.
StringProperty	title The title of this Dockable.
ObjectProperty<Tooltip>	tooltip The tooltip for this Dockable.

Field Summary

Fields inherited from interface org.drombler.commons.docking.DockableData

MODIFIED_PROPERTY_NAME, TITLE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
FXDockableData() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Registers a PropertyChangeListener for the specified property.
ObjectProperty<ContextMenu>	contextMenuProperty() The ContextMenu.
ContextMenu	getContextMenu() Gets the value of the property contextMenu.
Node	getGraphic() Gets the value of the property graphic.
GraphicFactory	getGraphicFactory() Gets the value of the property graphicFactory.
String	getTitle() Gets the value of the property title.
Tooltip	getTooltip() Gets the value of the property tooltip.
ObjectProperty<GraphicFactory>	graphicFactoryProperty() The GraphicFactory.
ObjectProperty<Node>	graphicProperty() The graphic of this Dockable.
boolean	isModified() Gets the value of the property modified.
BooleanProperty	modifiedProperty() The modified flag indicates if the data represented by the Dockable has been modified.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Unegisters a PropertyChangeListener for the specified property.
void	setContextMenu(ContextMenu contextMenu) Sets the value of the property contextMenu.
void	setGraphic(Node graphic) Sets the value of the property graphic.
void	setGraphicFactory(GraphicFactory graphicFactory) Sets the value of the property graphicFactory.
void	setModified(boolean modified) Sets the value of the property modified.
void	setTitle(String title) Sets the value of the property title.
void	setTooltip(Tooltip tooltip) Sets the value of the property tooltip.
StringProperty	titleProperty() The title of this Dockable.
ObjectProperty<Tooltip>	tooltipProperty() The tooltip for this Dockable.
String	toString()

Methods inherited from class java.lang.Object

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

Property Detail

title

public StringProperty titleProperty

The title of this Dockable. It is used to represent this Dockable e.g. in menus or tabs.

See Also:

getTitle(), setTitle(String)

tooltip

public ObjectProperty<Tooltip> tooltipProperty

The tooltip for this Dockable. It is used to provide additional information about this Dockable.

See Also:

getTooltip(), setTooltip(Tooltip)

graphic

public ObjectProperty<Node> graphicProperty

The graphic of this Dockable. It is used to represent this Dockable e.g. in menus or tabs. TODO: needed?

See Also:

getGraphic(), setGraphic(Node)

graphicFactory

public ObjectProperty<GraphicFactory> graphicFactoryProperty

The GraphicFactory.

See Also:

getGraphicFactory(), setGraphicFactory(GraphicFactory)

contextMenu

public ObjectProperty<ContextMenu> contextMenuProperty

The ContextMenu. TODO: needed?

See Also:

getContextMenu(), setContextMenu(ContextMenu)

modified

public BooleanProperty modifiedProperty

The modified flag indicates if the data represented by the Dockable has been modified.

See Also:

isModified(), setModified(boolean)

Constructor Detail

FXDockableData

public FXDockableData()

Creates a new instance of this class.

Method Detail

getTitle

public final String getTitle()

Gets the value of the property title.

Specified by:

getTitle in interface DockableData

Property description:

The title of this Dockable. It is used to represent this Dockable e.g. in menus or tabs.

Returns:

the title of a Dockable

setTitle

public final void setTitle(String title)

Sets the value of the property title.

Specified by:

setTitle in interface DockableData

Property description:

The title of this Dockable. It is used to represent this Dockable e.g. in menus or tabs.

Parameters:

title - the title of a Dockable

titleProperty

public StringProperty titleProperty()

The title of this Dockable. It is used to represent this Dockable e.g. in menus or tabs.

See Also:

getTitle(), setTitle(String)

getTooltip

public final Tooltip getTooltip()

Gets the value of the property tooltip.

Property description:

The tooltip for this Dockable. It is used to provide additional information about this Dockable.

setTooltip

public final void setTooltip(Tooltip tooltip)

Sets the value of the property tooltip.

Property description:

The tooltip for this Dockable. It is used to provide additional information about this Dockable.

tooltipProperty

public ObjectProperty<Tooltip> tooltipProperty()

The tooltip for this Dockable. It is used to provide additional information about this Dockable.

See Also:

getTooltip(), setTooltip(Tooltip)

getGraphic

public final Node getGraphic()

Gets the value of the property graphic.

Property description:

The graphic of this Dockable. It is used to represent this Dockable e.g. in menus or tabs. TODO: needed?

setGraphic

public final void setGraphic(Node graphic)

Sets the value of the property graphic.

Property description:

The graphic of this Dockable. It is used to represent this Dockable e.g. in menus or tabs. TODO: needed?

graphicProperty

public ObjectProperty<Node> graphicProperty()

The graphic of this Dockable. It is used to represent this Dockable e.g. in menus or tabs. TODO: needed?

See Also:

getGraphic(), setGraphic(Node)

getGraphicFactory

public final GraphicFactory getGraphicFactory()

Gets the value of the property graphicFactory.

Property description:

The GraphicFactory.

setGraphicFactory

public final void setGraphicFactory(GraphicFactory graphicFactory)

Sets the value of the property graphicFactory.

Property description:

The GraphicFactory.

graphicFactoryProperty

public ObjectProperty<GraphicFactory> graphicFactoryProperty()

The GraphicFactory.

See Also:

getGraphicFactory(), setGraphicFactory(GraphicFactory)

getContextMenu

public final ContextMenu getContextMenu()

Gets the value of the property contextMenu.

Property description:

The ContextMenu. TODO: needed?

setContextMenu

public final void setContextMenu(ContextMenu contextMenu)

Sets the value of the property contextMenu.

Property description:

The ContextMenu. TODO: needed?

contextMenuProperty

public ObjectProperty<ContextMenu> contextMenuProperty()

The ContextMenu. TODO: needed?

See Also:

getContextMenu(), setContextMenu(ContextMenu)

isModified

public final boolean isModified()

Gets the value of the property modified.

Specified by:

isModified in interface DockableData

Property description:

The modified flag indicates if the data represented by the Dockable has been modified.

setModified

public final void setModified(boolean modified)

Sets the value of the property modified.

Specified by:

setModified in interface DockableData

Property description:

The modified flag indicates if the data represented by the Dockable has been modified.

modifiedProperty

public BooleanProperty modifiedProperty()

The modified flag indicates if the data represented by the Dockable has been modified.

See Also:

isModified(), setModified(boolean)

addPropertyChangeListener

public final void addPropertyChangeListener(String propertyName,
                                            PropertyChangeListener listener)

Registers a PropertyChangeListener for the specified property.

Specified by:

addPropertyChangeListener in interface DockableData

Parameters:

propertyName - the property to observe

listener - the PropertyChangeListener to register

removePropertyChangeListener

public final void removePropertyChangeListener(String propertyName,
                                               PropertyChangeListener listener)

Unegisters a PropertyChangeListener for the specified property.

Specified by:

removePropertyChangeListener in interface DockableData

Parameters:

propertyName - the property to stop to observe

listener - the PropertyChangeListener to unregister

toString

public String toString()

Overrides:

toString in class Object