ilog.cpl.graphic

Class IlpGraphicRendererContext

java.lang.Object

ilog.cpl.graphic.IlpGraphicRendererContext

public class IlpGraphicRendererContext
extends Object

Contains the context information used to render a graphic object.

Since:

JTGO 3.0

Constructor Summary

Constructors

Constructor and Description
IlpGraphicRendererContext(boolean selected, boolean expanded, boolean focus, boolean showChildren) Creates a renderer context with the given initial information.
IlpGraphicRendererContext(IlpGraphicView view, IlpRepresentationObject ro, IlpAttribute attribute, boolean selected, boolean expanded, boolean focus, boolean showChildren) Creates a renderer context with the given initial information.

Method Summary

Modifier and Type	Method and Description
boolean	displayChildren() Returns whether the child objects of the object being rendered will be displayed.
boolean	equals(Object other) Compares two objects.
Object	getProperty(Object key) Deprecated.
Object	getPropertyValue(String property, IlpGraphicView view, IlpClass bclass, IlpAttribute battr) Retrieves the value of a styling property for a given a business attribute.
Object	getPropertyValue(String property, IlpGraphicView view, IlpRepresentationObject ro) Retrieves the value of a styling property for a given representation object in the graphic view.
Object	getPropertyValue(String property, IlpGraphicView view, IlpRepresentationObject ro, IlpAttribute a) Retrieves the value of a styling property for a given representation object in the graphic view.
String[]	getPseudoClasses() Returns the pseudoclasses used to configure the object in the given component.
boolean	hasFocus() Returns whether the object being rendered has focus.
boolean	hasProperty(Object key) Deprecated.
protected String[]	identifyPseudoClasses() This method sets the known pseudo-classes accordingly.
boolean	isExpanded() Returns whether the object being rendered is expanded.
boolean	isSelected() Returns whether the object being rendered is selected.
void	setProperty(Object key, Object value) Deprecated.
String	toString() Converts the object into a human-readable format.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpGraphicRendererContext

public IlpGraphicRendererContext(boolean selected,
                                 boolean expanded,
                                 boolean focus,
                                 boolean showChildren)

Creates a renderer context with the given initial information.

Use the constructor with the IlpGraphicView parameter if you use cascading style sheets with custom pseudoclasses.

Parameters:

selected - Indicates whether the object to be rendered is selected.

expanded - Indicates whether the object is expanded; that is, whether its child objects are also visible in the view. Always set to false in the table view.

focus - Indicates whether the object being rendered has the focus. Always set to false in the network view and equipment view.

showChildren - Indicates whether the child objects will be displayed as part of or in direct connection with the object. Always set to false in the tree view and table view.

IlpGraphicRendererContext

public IlpGraphicRendererContext(IlpGraphicView view,
                                 IlpRepresentationObject ro,
                                 IlpAttribute attribute,
                                 boolean selected,
                                 boolean expanded,
                                 boolean focus,
                                 boolean showChildren)

Creates a renderer context with the given initial information.

Parameters:

view - The graphic view

ro - The representation object

attribute - The business attribute

selected - Indicates whether the object to be rendered is selected.

expanded - Indicates whether the object is expanded; that is, whether its child objects are also visible in the view. Always set to false in the table view.

focus - Indicates whether the object being rendered has the focus. Always set to false in the network view and equipment view.

showChildren - Indicates whether the child objects will be displayed as part of or in direct connection with the object. Always set to false in the tree view and table view.

Since:

JTGO 3.5

Method Detail

isSelected

public boolean isSelected()

Returns whether the object being rendered is selected.

hasFocus

public boolean hasFocus()

Returns whether the object being rendered has focus.

isExpanded

public boolean isExpanded()

Returns whether the object being rendered is expanded.

displayChildren

public boolean displayChildren()

Returns whether the child objects of the object being rendered will be displayed.

getProperty

@Deprecated
public Object getProperty(Object key)

Deprecated.

Returns the value of the given property if there is one, otherwise returns null.

Deprecated Since:

JTGO 4.5

setProperty

@Deprecated
public void setProperty(Object key,
                                    Object value)

Deprecated.

Sets the value of a property. If the given value is null, the property is removed from the context.

Parameters:

key - Property key.

value - Property value; null indicates that the value should be removed from the context.

Deprecated Since:

JTGO 4.5

hasProperty

@Deprecated
public boolean hasProperty(Object key)

Deprecated.

Returns whether the given property has a value set in this context.

Parameters:

key - Property key being queried.

Deprecated Since:

JTGO 4.5

toString

public String toString()

Converts the object into a human-readable format.

Overrides:

toString in class Object

Returns:

The object in String format

equals

public boolean equals(Object other)

Compares two objects.

Overrides:

equals in class Object

Parameters:

other - The object to compare to

Returns:

true if the object is the same as this object false otherwise

identifyPseudoClasses

protected String[] identifyPseudoClasses()

This method sets the known pseudo-classes accordingly.

Since:

JViews 7.5

Internal: do not use!

getPseudoClasses

public String[] getPseudoClasses()

Returns the pseudoclasses used to configure the object in the given component.

The pseudoclasses are composed by the list of automatic pseudoclasses

• selected
• expanded
• focus

combined with the list of custom pseudoclasses defined by the user.

getPropertyValue

public Object getPropertyValue(String property,
                               IlpGraphicView view,
                               IlpRepresentationObject ro)

Retrieves the value of a styling property for a given representation object in the graphic view.

Styling properties are defined using cascading style sheets.

Parameters:

property - Property name

view - Graphic view

ro - Representation object

Since:

JTGO 3.5

See Also:

IlpStylableGraphicView, IlvStylable.setStyleSheets(java.lang.String[])

getPropertyValue

public Object getPropertyValue(String property,
                               IlpGraphicView view,
                               IlpRepresentationObject ro,
                               IlpAttribute a)

Retrieves the value of a styling property for a given representation object in the graphic view.

Styling properties are defined using cascading style sheets.

Parameters:

property - Property identifier

view - Graphic view

ro - Representation object

a - Business attribute

Since:

JTGO 3.5

See Also:

IlpStylableGraphicView, IlvStylable.setStyleSheets(java.lang.String[])

getPropertyValue

public Object getPropertyValue(String property,
                               IlpGraphicView view,
                               IlpClass bclass,
                               IlpAttribute battr)

Retrieves the value of a styling property for a given a business attribute.

The business attribute declarations are used by the Table Component to specify the characteristics of the table header.

Parameters:

property - Property name

view - Graphic view

bclass - Business Class

battr - Business attribute

Since:

JTGO 3.5