com.tensegrity.composite.event.group
Class GroupFoldStateChange

java.lang.Object
  com.tensegrity.composite.event.group.AbstractCompositeGroupEvent
      com.tensegrity.composite.event.group.GroupFoldStateChange

All Implemented Interfaces:

CompositeGroupEvent, CompositeRootEvent

public class GroupFoldStateChange

extends AbstractCompositeGroupEvent

A GroupFoldStateChange occurs whenever a CompositeGroups state of folding changes. This requires that a CompositeGroup is foldable.

Version:

$Id: GroupFoldStateChange.java,v 1.4 2006/02/10 16:24:28 MichaelKegel Exp $

Author:

MichaelKegel

See Also:

CompositeGroupEvent, CompositeGroupListener

Field Summary

Fields inherited from class com.tensegrity.composite.event.group.AbstractCompositeGroupEvent

composite, compositeGroup, composites

Constructor Summary

GroupFoldStateChange(CompositeGroup compositegroup)
Constructor for GroupFoldStateChange specifying the CompositeGroup whose fold state has been changed.

Method Summary

int	getFoldSate() Returns a constant that defines the actual fold state of the CompositeGroup.

Methods inherited from class com.tensegrity.composite.event.group.AbstractCompositeGroupEvent

getCompositeGroup

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupFoldStateChange

public GroupFoldStateChange(CompositeGroup compositegroup)

Constructor for GroupFoldStateChange specifying the CompositeGroup whose fold state has been changed.

Parameters:

compositegroup - the CompositeGroup for that the state of folding changed.

Method Detail

getFoldSate

public int getFoldSate()

Returns a constant that defines the actual fold state of the CompositeGroup. The possibly returned constants are defined in the CompositeGroup interface. To get more information about the fold states see their documentation CompositeGroup.FOLDSTATE_FOLDED

Returns:

int the actual fold state