com.tensegrity.composite
Interface CompositeGroupState

All Superinterfaces:

CompositeState

public interface CompositeGroupState

extends CompositeState

The CompositeGroupState interface defines a memento of the current state of a CompositeGroup. An instance of such an object can be obtained from and applied to a CompositeGroup.
Notice:The CompositeGroupState keeps only the states of elementary information about a CompositeGroup so that information about the current geometry, style, children and such is not remembered by an instance of this interface and hence not reapplied.

Version:

$Id: CompositeGroupState.java,v 1.5 2005/07/14 11:10:40 MichaelKegel Exp $

Author:

MKegel

Method Summary

java.util.Map	getChildStateMap()
int	getContentBorderBottom()
int	getContentBorderLeft()
int	getContentBorderRight()
int	getContentBorderTop()
double[]	getCoordinateSystemValues()
CompositeState	getFoldedRepresentationState()
int	getFoldState() Returns a constant that defines the fold-state of the CompositeGroup at the time the CompositeGroupState was created.
CompositeState	getFoldStateButtonState()
Size	getFoldStateSize() Returns the size for a certain fold-state of the CompositeGroup at the time the CompositeGroupState was created.
int	getHorizontalContentBorder() Returns the horizontal-content-border value of the CompositeGroup at the time the CompositeGroupState was created.
int	getSizeAdjustment() Returns a constant that defines the size-adjustment mode of the CompositeGroup at the time the CompositeGroupState was created.
int	getVerticalContentBorder() Returns the vertical-content-border value of the CompositeGroup at the time the CompositeGroupState was created.
boolean	isChildManipulationEnabled() Returns a boolean that indicates whether the children of the CompositeGroup are manipulable at the time the CompositeGroupState was created.
boolean	isChildMovementEnabled() Returns a boolean that indicates whether the children of the CompositeGroup are movable at the time the CompositeGroupState was created.
boolean	isChildSelectionEnabled() Returns a boolean that indicates whether the children of the CompositeGroup are selectable at the time the CompositeGroupState was created.
boolean	isDragSource() Returns a boolean that indicates whether the CompositeGroup behave as a drag-source at the time the CompositeGroupState was created.
boolean	isDropTarget() Returns a boolean that indicates whether the CompositeGroup behave as a drop-target at the time the CompositeGroupState was created.
boolean	isFoldable() Returns a boolean that indicates whether the CompositeGroup was foldable at the time the CompositeGroupState was created.
void	setSizeAdjustment(int sizeadjustment) Set the size adjustment for this CompositeGroupState to the value given by sizeadjustment.

Methods inherited from interface com.tensegrity.composite.CompositeState

getEventMask, getLocation, getMinimumSize, getPrimitiveStateMap, getSize

Method Detail

getHorizontalContentBorder

public int getHorizontalContentBorder()

Returns the horizontal-content-border value of the CompositeGroup at the time the CompositeGroupState was created.

Returns:

int the horizontal-content-border value of the CompositeGroup

getVerticalContentBorder

public int getVerticalContentBorder()

Returns the vertical-content-border value of the CompositeGroup at the time the CompositeGroupState was created.

Returns:

int the vertical-content-border value of the CompositeGroup

getContentBorderLeft

public int getContentBorderLeft()

getContentBorderRight

public int getContentBorderRight()

getContentBorderTop

public int getContentBorderTop()

getContentBorderBottom

public int getContentBorderBottom()

getSizeAdjustment

public int getSizeAdjustment()

Returns a constant that defines the size-adjustment mode of the CompositeGroup at the time the CompositeGroupState was created.

Returns:

int the size-adjustment mode of the CompositeGroup

setSizeAdjustment

public void setSizeAdjustment(int sizeadjustment)

Set the size adjustment for this CompositeGroupState to the value given by sizeadjustment.
NOTICE:This method is an internal of the composite API and will be removed in a future release. It is strongly recommended not to make use of it.

Parameters:

sizeadjustment - the new size adjustment value

getCoordinateSystemValues

public double[] getCoordinateSystemValues()

isChildSelectionEnabled

public boolean isChildSelectionEnabled()

Returns a boolean that indicates whether the children of the CompositeGroup are selectable at the time the CompositeGroupState was created.

Returns:

boolean a flag that indicates whether the children of the CompositeGroup are selectable

isChildMovementEnabled

public boolean isChildMovementEnabled()

Returns a boolean that indicates whether the children of the CompositeGroup are movable at the time the CompositeGroupState was created.

Returns:

boolean a flag that indicates whether the children of the CompositeGroup are movable

isChildManipulationEnabled

public boolean isChildManipulationEnabled()

Returns a boolean that indicates whether the children of the CompositeGroup are manipulable at the time the CompositeGroupState was created.

Returns:

boolean a flag that indicates whether the children of the CompositeGroup are manipulable

isDragSource

public boolean isDragSource()

Returns a boolean that indicates whether the CompositeGroup behave as a drag-source at the time the CompositeGroupState was created.

Returns:

boolean a flag that indicates whether the CompositeGroup behave as a drag-source

isDropTarget

public boolean isDropTarget()

Returns a boolean that indicates whether the CompositeGroup behave as a drop-target at the time the CompositeGroupState was created.

Returns:

boolean a flag that indicates whether the CompositeGroup behave as a drop-target

isFoldable

public boolean isFoldable()

Returns a boolean that indicates whether the CompositeGroup was foldable at the time the CompositeGroupState was created.

Returns:

boolean a flag that indicates whether the CompositeGroup is foldable

getFoldState

public int getFoldState()

Returns a constant that defines the fold-state of the CompositeGroup at the time the CompositeGroupState was created.

Returns:

int the fold-state of the CompositeGroup

getFoldStateSize

public Size getFoldStateSize()

Returns the size for a certain fold-state of the CompositeGroup at the time the CompositeGroupState was created.

Returns:

Size the size of the CompositeGroup for a certain fold-state

getFoldStateButtonState

public CompositeState getFoldStateButtonState()

getFoldedRepresentationState

public CompositeState getFoldedRepresentationState()

getChildStateMap

public java.util.Map getChildStateMap()