net.sf.doolin.gui.docking
Class DockingConstraint

java.lang.Object
  net.sf.doolin.gui.docking.DockingConstraint

public class DockingConstraint
extends Object

Specification for the constraints of a view in a DockingWindowDescriptor.

Constructor Summary

DockingConstraint()

Method Summary

int[]	getActions() Returns the list of actions that are available for the view (all actions but closed can be defined this way).
String	getDockingPath() Gets the docking path
boolean	isCloseable() Checks if he view can be closed
boolean	isExternalizable() Checks if the view can be externalized from its dock.
boolean	isHeader() Checks if the dock that contains the view must have a header
boolean	isMoveable() Checks if the view can be moved from its dock
boolean	isZoomable() Checks if the view can be zoomed
void	setCloseable(boolean closeable) Sets if the view can be closed
void	setDockingPath(String dockingPath) Path to the dock that must contain the view
void	setExternalizable(boolean externalizable) Defines if the view can be externalized from its dock.
void	setHeader(boolean header) Sets if the dock must have a header when docked alone
void	setMoveable(boolean moveable) Sets if the view can be moved from its dock
void	setZoomable(boolean zoomable) Sets true if the view can be zoomed
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DockingConstraint

public DockingConstraint()

Method Detail

getActions

public int[] getActions()

Returns the list of actions that are available for the view (all actions but closed can be defined this way).

Returns:

List of actions

getDockingPath

public String getDockingPath()

Gets the docking path

Returns:

Docking path

isCloseable

public boolean isCloseable()

Checks if he view can be closed

Returns:

true if the view can be closed

isExternalizable

public boolean isExternalizable()

Checks if the view can be externalized from its dock.

Returns:

Externalizable state

isHeader

public boolean isHeader()

Checks if the dock that contains the view must have a header

Returns:

true if the dock that contains the view must have a header

isMoveable

public boolean isMoveable()

Checks if the view can be moved from its dock

Returns:

true if the view can be moved from its dock

isZoomable

public boolean isZoomable()

Checks if the view can be zoomed

Returns:

true if the view can be zoomed

setCloseable

public void setCloseable(boolean closeable)

Sets if the view can be closed

Parameters:

closeable - true if the view can be closed

setDockingPath

public void setDockingPath(String dockingPath)

Path to the dock that must contain the view

Parameters:

dockingPath - Docking path

setExternalizable

public void setExternalizable(boolean externalizable)

Defines if the view can be externalized from its dock.

Parameters:

externalizable - Externalizable state

setHeader

public void setHeader(boolean header)

Sets if the dock must have a header when docked alone

Parameters:

header - true if the dockable must have a header when docked alone

setMoveable

public void setMoveable(boolean moveable)

Sets if the view can be moved from its dock

Parameters:

moveable - Moveable state

setZoomable

public void setZoomable(boolean zoomable)

Sets true if the view can be zoomed

Parameters:

zoomable - Zoomable state

toString

public String toString()

Overrides:

toString in class Object