com.sun.electric.database.variable

Class DisplayedText

java.lang.Object

com.sun.electric.database.variable.DisplayedText

All Implemented Interfaces:

java.io.Serializable

public class DisplayedText
extends java.lang.Object
implements java.io.Serializable

DisplayedText is the combination of an ElectricObject and a Variable Key.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DisplayedText(ElectricObject eObj, Variable.Key key)

Method Summary

Modifier and Type	Method and Description
ElectricObject	getElectricObject()
Variable	getVariable()
Variable.Key	getVariableKey()
boolean	movesWithText() Method to tell whether this DisplayedText stays with its node.
static boolean	objectMovesWithText(ElectricObject eObj, Variable.Key key) Method to tell whether text stays with its node.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayedText

public DisplayedText(ElectricObject eObj,
                     Variable.Key key)

Method Detail

getElectricObject

public ElectricObject getElectricObject()

getVariableKey

public Variable.Key getVariableKey()

getVariable

public Variable getVariable()

movesWithText

public boolean movesWithText()

Method to tell whether this DisplayedText stays with its node. The two possibilities are (1) text on invisible pins (2) export names, when the option to move exports with their labels is requested.

Returns:

true if this DisplayedText should move with its node.

objectMovesWithText

public static boolean objectMovesWithText(ElectricObject eObj,
                                          Variable.Key key)

Method to tell whether text stays with its node. The two possibilities are (1) text on invisible pins (2) export names, when the option to move exports with their labels is requested.

Parameters:

eObj - the ElectricObject with text on it.

key - the Variable Key of the text on the object.

Returns:

true if the text should move with its node.