org.drombler.commons.docking

Class DockingAreaDescriptor

java.lang.Object

org.drombler.commons.docking.DockingAreaDescriptor

public final class DockingAreaDescriptor
extends Object

The Docking Area descriptor describes a Docking Area. TODO: Immutable?

Author:

puce

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId() Gets the Docking Area ID.
DockingAreaKind	getKind() Gets the Docking Area kind.
LayoutConstraintsDescriptor	getLayoutConstraints() Gets the layout constraints of the Docking Area.
List<Integer>	getParentPath() Gets the path positions of the parent split pane.
int	getPosition() Gets the position of the Docking Area in the parent split pane.
int	hashCode()
boolean	isAdHoc() Indicates if the Docking Area has been registered or created ad hoc.
boolean	isPermanent() Returns true, if the Docking Area is visible also when it's empty (permanently visible), and returns false, if the Docking Area is only visible when it's not empty
void	setAdHoc(boolean adHoc) Marks if the Docking Area has been registered or created ad hoc.
void	setId(String id) Sets the Docking Area ID.
void	setKind(DockingAreaKind kind) Sets the Docking Area kind.
void	setLayoutConstraints(LayoutConstraintsDescriptor layoutConstraints) Sets the layout constraints of the Docking Area.
void	setParentPath(List<Integer> parentPath) Sets the path positions of the parent split pane.
void	setPermanent(boolean permanent) Specifies if the Docking Area should be permanently visible.
void	setPosition(int position) Sets the position of the Docking Area in the parent split pane.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DockingAreaDescriptor

public DockingAreaDescriptor()

Creates a new instance of this class.

Method Detail

getId

public String getId()

Gets the Docking Area ID.

Returns:

the Docking Area ID

setId

public void setId(String id)

Sets the Docking Area ID.

Parameters:

id - the Docking Area ID

getKind

public DockingAreaKind getKind()

Gets the Docking Area kind.

Returns:

the Docking Area kind

setKind

public void setKind(DockingAreaKind kind)

Sets the Docking Area kind.

Parameters:

kind - the Docking Area kind

getPosition

public int getPosition()

Gets the position of the Docking Area in the parent split pane.

Returns:

the position of the Docking Area in the parent split pane

setPosition

public void setPosition(int position)

Sets the position of the Docking Area in the parent split pane.

Parameters:

position - the position of the Docking Area in the parent split pane

getParentPath

public List<Integer> getParentPath()

Gets the path positions of the parent split pane.

Returns:

the path positions of the parent split pane

setParentPath

public void setParentPath(List<Integer> parentPath)

Sets the path positions of the parent split pane.

Parameters:

parentPath - the path positions of the parent split pane

isPermanent

public boolean isPermanent()

Returns true, if the Docking Area is visible also when it's empty (permanently visible), and returns false, if the Docking Area is only visible when it's not empty

Returns:

true if permanently visible, else false

setPermanent

public void setPermanent(boolean permanent)

Specifies if the Docking Area should be permanently visible. If true, the Docking Area is visible also when it's empty (permanently visible), else the Docking Area is only visible when it's not empty.

Parameters:

permanent - If true, the Docking Area is visible also when it's empty (permanently visible), else the Docking Area is only visible when it's not empty

getLayoutConstraints

public LayoutConstraintsDescriptor getLayoutConstraints()

Gets the layout constraints of the Docking Area.

Returns:

the layout constraints of the Docking Area

setLayoutConstraints

public void setLayoutConstraints(LayoutConstraintsDescriptor layoutConstraints)

Sets the layout constraints of the Docking Area.

Parameters:

layoutConstraints - the layout constraints of the Docking Area

setAdHoc

public void setAdHoc(boolean adHoc)

Marks if the Docking Area has been registered or created ad hoc.

Parameters:

adHoc - true, if the Docking Area has been created ad hoc, else false.

isAdHoc

public boolean isAdHoc()

Indicates if the Docking Area has been registered or created ad hoc.

Returns:

true, if the Docking Area has been created ad hoc, else false.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object