ilog.tgo.graphic

Class IltSecondaryStatePositioner

java.lang.Object

ilog.tgo.graphic.IltSecondaryStatePositioner

public class IltSecondaryStatePositioner
extends Object

This class lets you assign a fixed position to a secondary state icon. Icons can be placed on top of the graphic element (ordinary positions), or on the left or right side of the graphic element (inState or outState positions).

There can only be one icon on each side of an element.

The ordinary positions are numbered from 0 and are used for all types of elements (network elements, links, groups, shelf items). If no icon ends up being placed at a position, the position remains transparent. If two icons end up at the same position, the second one is placed on a free position.

Since:

JTGO 2.5

Method Summary

Modifier and Type	Method and Description
static IltSecondaryStatePositioner	GetInstance() Returns the only instance of IltSecondaryStatePositioner.
IltDecorationSource	getInState() Returns the state that is placed at the InState position.
IltDecorationSource	getOutState() Returns the state that is placed at the OutState position.
int	getPosition(IltDecorationSource state) Returns the position assigned to the specified state, or -1 if none is found.
boolean	isStackerActive()
void	setInState(IltDecorationSource state) Sets the state that is placed at the InState position.
void	setOutState(IltDecorationSource state) Sets the state that is placed at the OutState position.
void	setPosition(IltDecorationSource state, int position) Assigns a position in the secondary state stacker to a specific state.

Methods inherited from class java.lang.Object

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

Method Detail

GetInstance

public static IltSecondaryStatePositioner GetInstance()

Returns the only instance of IltSecondaryStatePositioner. The class is a Singleton.

isStackerActive

public boolean isStackerActive()

Internal: do not use!

setPosition

public void setPosition(IltDecorationSource state,
                        int position)

Assigns a position in the secondary state stacker to a specific state. The first position is 0. A negative position removes the state from the list.

getPosition

public int getPosition(IltDecorationSource state)

Returns the position assigned to the specified state, or -1 if none is found.

setInState

public void setInState(IltDecorationSource state)

Sets the state that is placed at the InState position.

getInState

public IltDecorationSource getInState()

Returns the state that is placed at the InState position.

setOutState

public void setOutState(IltDecorationSource state)

Sets the state that is placed at the OutState position.

getOutState

public IltDecorationSource getOutState()

Returns the state that is placed at the OutState position.