|
||||||||||
| PREV CLASS Documentation homepage NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectilog.cpl.model.IlpDefaultObject
ilog.tgo.model.IltObject
ilog.tgo.model.IltGroup
public abstract class IltGroup
This class models network groups.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class ilog.tgo.model.IltObject |
|---|
IltObject.ListPrimaryStateStyleValueProvider, IltObject.LogicalType, IltObject.TinyType |
| Field Summary | |
|---|---|
protected static ilog.util.internal.IlAVector |
_MappedForUser
|
static IlpPointKey |
DecorationsOffset
Deprecated. Please use CSS property decorationsOffset instead. |
static IltAttribute |
IconAttribute
The icon of the group. |
static IlpBooleanKey |
LinksConnectToBase
Deprecated. Please use CSS property linksConnectToBase instead. |
static IltObjectInfo |
metainfo
Contains metainformation about this IltObject class. |
static IlpBooleanKey |
PinDecorations
Deprecated. Please use CSS property pinDecorations instead. |
static IltAttribute |
ShortcutAttribute
Attribute used to define whether the group is a shortcut group or not. |
static IlpBooleanKey |
ZoomableDecorationsOffset
Deprecated. Please use CSS property decorationsOffsetZoomable instead. |
| Fields inherited from interface ilog.cpl.model.IlpAttributeValueHolder |
|---|
VALUE_NOT_SET |
| Constructor Summary | |
|---|---|
IltGroup(IlpClass ilpClass,
Object identifier)
Creates a new group with a given class and identifier. |
|
IltGroup(IltObjectState state)
Creates a new group. |
|
IltGroup(IltObjectState state,
String label)
Creates a new group. |
|
IltGroup(Object identifier)
Creates a new group with a given identifier. |
|
| Method Summary | |
|---|---|
boolean |
areDecorationsPinned()
Deprecated. Please use the CSS property pinDecorations |
protected boolean |
areDecorationsPinned(IltGraphic graphic)
|
boolean |
areDecorationsPinned(IltGraphicManager manager)
Deprecated. Please use the CSS property pinDecorations |
protected void |
copyFrom(IltGroup other)
Support for renderer. |
static void |
ForceInit(ilog.tgo.util.internal.IltForceClassInit object)
|
static IltLegend |
GetClassLegend()
Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please refer to the User's Manual for further information. |
IlvPoint |
getDecorationsCenterPoint()
Deprecated. Please use CSS property decorationsOffset instead. |
IlvPoint |
getDecorationsCenterPoint(IltGraphicManager manager)
Deprecated. Please use CSS property decorationsOffset instead. |
protected IlvPoint |
getDecorationsCenterPoint(IltGraphicManager manager,
IltGraphic graphic)
Returns the absolute center point of the group information cluster in a specific graphical representation. |
IlvPoint |
getDecorationsOffset()
Deprecated. Please use the CSS property decorationsOffset |
IlvPoint |
getDecorationsOffset(IltGraphicManager manager)
Deprecated. Please use CSS property decorationsOffset |
protected IlvPoint |
getDecorationsOffset(IltGraphicManager manager,
IltGraphic graphic)
Returns the decorations offset for the given graphical representation. |
Image |
getIcon()
Returns the icon of the group |
static IltObjectInfo |
GetIlpClass()
Returns the IlpClass corresponding to this Java class. |
ilog.util.internal.IlAVector |
getMappedForUserList()
|
IltShortcutAttributeType |
getShortcut()
Returns whether the group is a shortcut or not. |
void |
pinDecorations(boolean pin)
Deprecated. Please use the CSS property pinDecorations |
void |
pinDecorations(IltGraphicManager manager,
boolean pin)
Deprecated. Please use the CSS property pinDecorations |
void |
resetDecorationsCenterPoint()
Deprecated. Please use CSS property decorationsOffset instead. |
void |
resetDecorationsCenterPoint(IltGraphicManager manager)
Deprecated. Please use CSS property decorationsOffset instead. |
void |
resetDecorationsOffset()
Deprecated. Please use CSS property decorationsOffset |
void |
resetDecorationsOffset(IltGraphicManager manager)
Deprecated. Please use the CSS property decorationsOffset |
void |
resetPinDecorations()
Deprecated. Please use the CSS property pinDecorations |
void |
resetPinDecorations(IltGraphicManager manager)
Deprecated. Please use the CSS property pinDecorations |
void |
setAttributeValue(IlpAttribute attribute,
Object value)
Sets the value of an attribute of this object. |
protected void |
setDecorationsCenterPoint(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint centerPoint)
Sets the absolute center point of the group information cluster in a given manager. |
void |
setDecorationsCenterPoint(IltGraphicManager manager,
IlvPoint centerPoint)
Deprecated. Please use CSS property decorationsOffset instead. |
void |
setDecorationsCenterPoint(IlvPoint centerPoint)
Deprecated. Please use CSS property decorationsOffset instead. |
protected void |
setDecorationsOffset(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint offset)
Sets the relative position of the group information cluster in a given manager according to the center of gravity. |
void |
setDecorationsOffset(IltGraphicManager manager,
IlvPoint offset)
Deprecated. Please use CSS property decorationsOffset |
void |
setDecorationsOffset(IlvPoint offset)
Deprecated. Please use CSS property decorationsOffset |
void |
setIcon(Image icon)
Sets an icon to be displayed inside the group. |
void |
setProperty(Object name,
Object value)
Sets the named property. |
void |
setShape(IltGraphicManager manager,
IltGraphic graphic,
Object shape,
IlpPositionSource reason)
Update the graphic settings related to shape and GIC offsets. |
void |
setShortcut(IltShortcutAttributeType value)
Sets the group as a shortcut. |
String |
toString()
Returns the String representation of this Iltgroup's values. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static IltObjectInfo metainfo
IltObject class.
public static IltAttribute IconAttribute
Attribute name: icon.
Value type: Image.
public static IltAttribute ShortcutAttribute
A shortcut group is an abstraction representing that this group is only a reference to an existing group. The possible values for this attribute are:
IltShortcutAttributeType.STANDARD: this group is a
normal shortcut.
IltShortcutAttributeType.DANGLING: this group is a
shortcut to an object that is no longer available.
null: the group is not a shortcut.
Shortcut groups are graphically represented by an icon that is placed at the bottom left-side of the group base.
Attribute name: shortcut.
Value type: IltShortcutAttributeType.
getShortcut(),
setShortcut(ilog.tgo.model.attribute.IltShortcutAttributeType)public static IlpBooleanKey LinksConnectToBase
linksConnectToBase instead.true, links will connect to the bounding
box of the base. Otherwise, links will connect to the group information
cluster, if one is present.
The default value is false.
IltObjectCustomization.getLinksConnectToBase()public static IlpBooleanKey PinDecorations
pinDecorations instead.false.
IltObjectCustomization.getPinDecorations()public static IlpPointKey DecorationsOffset
decorationsOffset instead.IlvPoint(0,0).
IltObjectCustomization.getDecorationsOffset()public static IlpBooleanKey ZoomableDecorationsOffset
decorationsOffsetZoomable instead.false.
IltObjectCustomization.isDecorationsOffsetZoomable()protected static ilog.util.internal.IlAVector _MappedForUser
| Constructor Detail |
|---|
public IltGroup(IltObjectState state,
String label)
state - its semantic statelabel - its labelpublic IltGroup(IltObjectState state)
state - its semantic statepublic IltGroup(Object identifier)
identifier - the identifier of this new instance
public IltGroup(IlpClass ilpClass,
Object identifier)
ilpClass - the business class of this new instance. It must be a
subclass of IltGroupidentifier - the identifier of this new instance| Method Detail |
|---|
public static IltObjectInfo GetIlpClass()
IlpClass corresponding to this Java class.
Here the IlpClass interface is implemented by IltObjectInfo.
public static IltLegend GetClassLegend()
public void setShape(IltGraphicManager manager,
IltGraphic graphic,
Object shape,
IlpPositionSource reason)
public Image getIcon()
public void setIcon(Image icon)
public IltShortcutAttributeType getShortcut()
public void setShortcut(IltShortcutAttributeType value)
public void setAttributeValue(IlpAttribute attribute,
Object value)
VALUE_NOT_SET for the value
argument.
setAttributeValue in interface IlpAttributeValueHoldersetAttributeValue in class IltObjectattribute - The attribute which value is set.value - The new value of the attribute or VALUE_NOT_SET
to remove the value of the attribute.
IllegalArgumentException - if the attribute cannot have
its value modified.
public void setProperty(Object name,
Object value)
setProperty in interface IlWithPropertiessetProperty in class IltObjectname - Property identifiervalue - Property valuepublic IlvPoint getDecorationsCenterPoint()
decorationsOffset instead.
setDecorationsCenterPoint(x, y).
If nothing was set, this method returns null.
public void setDecorationsCenterPoint(IlvPoint centerPoint)
decorationsOffset instead.
setDecorationsCenterPoint(IltGraphicManager,IlvPoint).
If there are instances that use this value, they are
automatically updated by this change, setting the new center point
of their decorations.
public void resetDecorationsCenterPoint()
decorationsOffset instead.
public IlvPoint getDecorationsCenterPoint(IltGraphicManager manager)
decorationsOffset instead.
protected IlvPoint getDecorationsCenterPoint(IltGraphicManager manager,
IltGraphic graphic)
public void setDecorationsCenterPoint(IltGraphicManager manager,
IlvPoint centerPoint)
decorationsOffset instead.
protected void setDecorationsCenterPoint(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint centerPoint)
public void resetDecorationsCenterPoint(IltGraphicManager manager)
decorationsOffset instead.
public IlvPoint getDecorationsOffset()
decorationsOffset
public void setDecorationsOffset(IlvPoint offset)
decorationsOffset
This value is overwritten if the relative position is set in
each graphic representation using setDecorationsOffset (IltGraphicManager)
This method defines an offset to all graphical representations of a certain
group.
This method is setting the value in the object style just in the default application context
public void resetDecorationsOffset()
decorationsOffset
This method is setting the value in the object style just in the default application context
public IlvPoint getDecorationsOffset(IltGraphicManager manager)
decorationsOffset
setDecorationsOffset(IltGraphicManager) method.
If nothing was set, it returns the value set using setDecorationsOffset().
If nothing was set in both situations, it returns the default offset
of (0, 0).
protected IlvPoint getDecorationsOffset(IltGraphicManager manager,
IltGraphic graphic)
public void setDecorationsOffset(IltGraphicManager manager,
IlvPoint offset)
decorationsOffset
protected void setDecorationsOffset(IltGraphicManager manager,
IltGraphic graphic,
IlvPoint offset)
public void resetDecorationsOffset(IltGraphicManager manager)
decorationsOffset
public boolean areDecorationsPinned()
pinDecorations
This method is setting the value in the object style just in the default application context
public void pinDecorations(boolean pin)
pinDecorations
pinDecorations (IltGraphicManager, boolean) method.
This method is setting the value in the object style just in the default application context
public boolean areDecorationsPinned(IltGraphicManager manager)
pinDecorations
protected boolean areDecorationsPinned(IltGraphic graphic)
public void pinDecorations(IltGraphicManager manager,
boolean pin)
pinDecorations
public void resetPinDecorations(IltGraphicManager manager)
pinDecorations
public void resetPinDecorations()
pinDecorations
This method is setting the value in the object style just in the default application context
protected void copyFrom(IltGroup other)
public String toString()
toString in class IlpDefaultObjectpublic ilog.util.internal.IlAVector getMappedForUserList()
getMappedForUserList in class IltObjectpublic static void ForceInit(ilog.tgo.util.internal.IltForceClassInit object)
|
||||||||||
| PREV CLASS Documentation homepage NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||