com.yworks.yfiles.layout

Class Swimlanes.SwimlaneRepresentative

java.lang.Object

com.yworks.yfiles.layout.Swimlanes.SwimlaneRepresentative

Enclosing class:

Swimlanes

public static class Swimlanes.SwimlaneRepresentative
extends Object

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

Constructor Summary

Constructors

Constructor and Description
SwimlaneRepresentative(int swimlanePos, boolean allowRearrangement) Creates a new Swimlanes.SwimlaneRepresentative instance.

Method Summary

Modifier and Type	Method and Description
int	getSwimlanePos() Gets the current position of the represented swimlane.
boolean	isRearrangementAllowed() Gets whether or not the represented swimlane can be rearranged.
void	setRearrangementAllowed(boolean value) Sets whether or not the represented swimlane can be rearranged.
void	setSwimlanePos(int value) Sets 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

SwimlaneRepresentative

public SwimlaneRepresentative(int swimlanePos,
                              boolean allowRearrangement)

Creates a new Swimlanes.SwimlaneRepresentative 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()

Gets the current position of the represented swimlane.

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

Throws:

IllegalArgumentException - if the position is smaller than 0

Returns:

the current position of the swimlane

See Also:

setSwimlanePos(int)

isRearrangementAllowed

public boolean isRearrangementAllowed()

Gets whether or not the represented swimlane can be rearranged.

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

Returns:

true if the represented swimlane can be rearranged, false otherwise

See Also:

setRearrangementAllowed(boolean)

setRearrangementAllowed

public void setRearrangementAllowed(boolean value)

Sets whether or not the represented swimlane can be rearranged.

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

Parameters:

value - true if the represented swimlane can be rearranged, false otherwise

See Also:

isRearrangementAllowed()

setSwimlanePos

public void setSwimlanePos(int value)

Sets the current position of the represented swimlane.

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

Throws:

IllegalArgumentException - if the position is smaller than 0

Parameters:

value - the current position of the swimlane

See Also:

getSwimlanePos()