Search this API

y.layout
Class Swimlanes.SwimlaneRepresentant

java.lang.Object
  extended by y.layout.Swimlanes.SwimlaneRepresentant
Enclosing class:
Swimlanes

public static class Swimlanes.SwimlaneRepresentant
extends java.lang.Object

A SwimlaneRepresentant represents the position and arrangement mode for a swimlane.

 

Constructor Summary
Swimlanes.SwimlaneRepresentant(int swimlanePos, boolean allowRearrangement)
          Creates a new Swimlanes.SwimlaneRepresentant instance.
 
Method Summary
 int getSwimlanePos()
          Returns the current position of the represented swimlane.
 boolean isAllowRearrangement()
          Returns whether or not the represented swimlane can be rearranged.
 void setAllowRearrangement(boolean allowRearrangement)
          Specifies whether or not the represented swimlane can be rearranged.
 void setSwimlanePos(int swimlanePos)
          Specifies the current position of the represented swimlane.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Swimlanes.SwimlaneRepresentant

public Swimlanes.SwimlaneRepresentant(int swimlanePos,
                                      boolean allowRearrangement)
Creates a new Swimlanes.SwimlaneRepresentant instance.

Parameters:
swimlanePos - denotes the current position of the represented swimlane
allowRearrangement - true if the represented swimlane may be rearranged, false otherwise
Method Detail

getSwimlanePos

public int getSwimlanePos()
Returns the current position of the represented swimlane.

The swimlane positions are described by a zero-based index and must not be negative.

Returns:
the current position of the swimlane
See Also:
setSwimlanePos(int)

setSwimlanePos

public void setSwimlanePos(int swimlanePos)
Specifies the current position of the represented swimlane.

The swimlane positions are described by a zero-based index and must not be negative.

Parameters:
swimlanePos - the current position of the swimlane
Throws:
java.lang.IllegalArgumentException - if the position is smaller than 0

isAllowRearrangement

public boolean isAllowRearrangement()
Returns whether or not the represented swimlane can be rearranged.

For all swimlanes with disabled rearrangement, the relative ordering given by getSwimlanePos() is preserved. The other swimlanes may be rearranged.

Returns:
true if the represented swimlane can be rearranged, false otherwise
See Also:
setAllowRearrangement(boolean)

setAllowRearrangement

public void setAllowRearrangement(boolean allowRearrangement)
Specifies whether or not the represented swimlane can be rearranged.

For all swimlanes with disabled rearrangement, the relative ordering given by getSwimlanePos() is preserved. The other swimlanes may be rearranged.

Parameters:
allowRearrangement - true if the represented swimlane can be rearranged, false otherwise

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.