ilog.cpl.css

Interface IlpAttributeCustomization

public interface IlpAttributeCustomization

This interface contains all the properties that can be customized in order to define the graphic representation of a business attribute in the JTGO Graphic Components.

The properties defined in this class can be used in the following cascading style sheet selectors:

object."MyBusinessClass/attributeOne" {
     labelVisible: true;
     label: @attributeOne;
     iconVisible: true;
     icon: '@|image("myImage")';
}

object."MyBusinessClass/attributeTwo" {
     visibleInSystemWindow: true;
     label: @attributeTwo;
     captionLabelVisible: false;
}
   

Since:

JTGO 3.5

Method Summary

Modifier and Type	Method and Description
Color	getAlarmBalloonBorderColor() Deprecated. Please use IlvRoundRectBalloon instead.
Color	getAlarmBalloonColor() Deprecated. Please use IlvRoundRectBalloon instead.
int	getAlarmBalloonOrientation() Deprecated. Please use IlvRoundRectBalloon instead.
int	getAlarmBalloonPointerDepth() Deprecated. Please use IlvRoundRectBalloon instead.
int	getAlarmBalloonPointerDistance() Deprecated. Please use IlvRoundRectBalloon instead.
int	getAlarmBalloonRadius() Deprecated. Please use IlvRoundRectBalloon instead.
Color	getAlarmBalloonShadowColor() Deprecated. Please use IlvRoundRectBalloon instead.
int	getAlarmBalloonShadowThickness() Deprecated. Please use IlvRoundRectBalloon instead.
String	getCaptionLabel() Denotes the text used as an attribute description in the System Window.
int	getCenteredInsets() Deprecated. Please use a composite graphic with a centered layout instead.
Color	getFocusBorderColor() Returns the color of the border of the attribute when it has focus.
int	getFocusBorderWidth() Returns the width of focus border.
IlpGraphicRenderer	getGraphicRenderer() Deprecated. Please use class property in your CSS files, defining the JComponent or IlvGraphic that will be used to represent the business attribute.
int	getHorizontalAlignment() Returns the horizontal alignment of the label in the table cell.
Image	getIcon() Returns the image that will be displayed as the icon in the graphical representation of the attribute.
Color	getInfoBalloonBorderColor() Deprecated. Please use IlvRectBalloon instead.
Color	getInfoBalloonColor() Deprecated. Please use IlvRectBalloon instead.
int	getInfoBalloonOrientation() Deprecated. Please use IlvRectBalloon instead.
int	getInfoBalloonPointerDepth() Deprecated. Please use IlvRectBalloon instead.
Color	getInfoBalloonShadowColor() Deprecated. Please use IlvRectBalloon instead.
int	getInfoBalloonShadowThickness() Deprecated. Please use IlvRectBalloon instead.
IlpObjectInteractor	getInteractor() Returns the object interactor currently set in this representation object attribute.
String	getLabel() Returns the text used as a label.
Color	getLabelBackground() Returns the background color of the label text.
Font	getLabelFont() Returns the font that will be used to display the label.
Color	getLabelForeground() Returns the foreground color of the label text.
int	getLabelInsets() Returns the insets (in pixels) of the attribute.
int	getLabelPosition() Returns the position of the text of the label, relative to the icon.
double	getLabelSpacing() Returns the spacing between the icon and the label.
int	getStackerAlignment() Deprecated. Please use a Composite Graphic with a Stacker Layout instead.
int	getStackerOrientation() Deprecated. Please use a Composite Graphic with a Stacker Layout instead.
int	getStackerSpacing() Deprecated. Please use a Composite Graphic with a Stacker Layout instead.
Color	getToolTipBackground() Returns the text tooltip background color.
Font	getToolTipFont() Returns the font used to create the text tooltip for an object.
Color	getToolTipForeground() Returns the text tooltip foreground color.
Object	getToolTipGraphic() Returns the tooltip graphic object.
IlpGraphicRenderer	getToolTipRenderer() Deprecated. Please use property toolTipGraphic instead.
String	getToolTipText() Returns the text used as tooltip for an object.
int	getVerticalAlignment() Returns the vertical alignment of the label in the table cell.
boolean	isCaptionLabelVisible() Returns whether the label displayed in the header is visible.
boolean	isIconVisible() Returns whether the icon that is part of the graphical representation of the attribute is visible.
boolean	isLabelVisible() Returns whether the label should be visible or not in the graphical representation of the attribute.
boolean	isUseDefaultCellRenderer() This property denotes the use of the default table cell renderer to render table cells.
boolean	isVisibleInSystemWindow() Returns whether an attribute should be added to the System Window or not.

Method Detail

isLabelVisible

boolean isLabelVisible()

Returns whether the label should be visible or not in the graphical representation of the attribute.

Default value: Boolean.TRUE.

See Also:

IlpAttributeKeys.LabelVisible

getLabel

String getLabel()

Returns the text used as a label.

Default value: none.

See Also:

IlpAttributeKeys.LabelString

getLabelFont

Font getLabelFont()

Returns the font that will be used to display the label.

Default value: none.

See Also:

IlpAttributeKeys.LabelFont

getLabelPosition

int getLabelPosition()

Returns the position of the text of the label, relative to the icon.

Legal values are:

• IlvDirection.Bottom
• IlvDirection.Center
• IlvDirection.Left
• IlvDirection.Right
• IlvDirection.Top

Default value: IlvDirection.Right.

See Also:

IlpAttributeKeys.LabelPosition

getLabelInsets

int getLabelInsets()

Returns the insets (in pixels) of the attribute.

Default value: 1.

See Also:

IlpAttributeKeys.LabelInsets

getLabelSpacing

double getLabelSpacing()

Returns the spacing between the icon and the label.

Default value: 4.

See Also:

IlpAttributeKeys.LabelSpacing

getLabelForeground

Color getLabelForeground()

Returns the foreground color of the label text.

Default value: none.

Note: Blinking colors are not supported.

See Also:

IlpAttributeKeys.LabelForegroundColor, IlpAttributeKeys.SelectionForegroundColor

getLabelBackground

Color getLabelBackground()

Returns the background color of the label text.

Default value: none.

Note: Blinking colors are not supported.

See Also:

IlpAttributeKeys.LabelBackgroundColor, IlpAttributeKeys.SelectionBackgroundColor

getFocusBorderColor

Color getFocusBorderColor()

Returns the color of the border of the attribute when it has focus.

Default value: none.

Note: Blinking colors are not supported.

See Also:

IlpAttributeKeys.FocusBorderColor, getFocusBorderWidth()

getFocusBorderWidth

int getFocusBorderWidth()

Returns the width of focus border.

Default value: 1.

See Also:

getFocusBorderColor(), IlpAttributeKeys.FocusBorderThickness

getHorizontalAlignment

int getHorizontalAlignment()

Returns the horizontal alignment of the label in the table cell.

Valid values for HORIZONTAL_ALIGNMENT are:

• SwingConstants.CENTER
• SwingConstants.LEFT
• SwingConstants.RIGHT

Default value: javax.swing.SwingConstants.LEFT

See Also:

IlpAttributeKeys.HorizontalAlignment

getVerticalAlignment

int getVerticalAlignment()

Returns the vertical alignment of the label in the table cell.

Valid values for VERTICAL_ALIGNMENT are:

• SwingConstants.CENTER
• SwingConstants.TOP
• SwingConstants.BOTTOM

Default value: SwingConstants.CENTER.

See Also:

IlpAttributeKeys.VerticalAlignment

isIconVisible

boolean isIconVisible()

Returns whether the icon that is part of the graphical representation of the attribute is visible.

Default value: true.

See Also:

IlpAttributeKeys.IconVisible

getIcon

Image getIcon()

Returns the image that will be displayed as the icon in the graphical representation of the attribute.

Default value: none.

See Also:

IlpAttributeKeys.Icon

getInteractor

IlpObjectInteractor getInteractor()

Returns the object interactor currently set in this representation object attribute.

Default value: none

Object interactors can be customized in a CSS as JavaBeans.

Since:

JTGO 4.0

See Also:

IlpObjectInteractor

getToolTipText

String getToolTipText()

Returns the text used as tooltip for an object.

Default value: none.

See Also:

IlpAttributeKeys.ToolTipString, IlpToolTipManager

getToolTipRenderer

@Deprecated
IlpGraphicRenderer getToolTipRenderer()

Deprecated. Please use property toolTipGraphic instead.

Returns the renderer used to create tooltips that are graphic instances. This property has precedence over tooltip text property.

Default value: none.

See Also:

IlpAttributeKeys.ToolTipRenderer, IlpGraphicRenderer, IlpToolTipManager

Deprecated Since:

JTGO 4.0

getToolTipGraphic

Object getToolTipGraphic()

Returns the tooltip graphic object.

The tooltip graphic can be created using CSS as a JComponent or an IlvGraphic instance.

This property has precedence over the tooltip text property.

Default value: none

Since:

JTGO 4.0

See Also:

getToolTipText(), JComponent, IlvGraphic

getToolTipFont

Font getToolTipFont()

Returns the font used to create the text tooltip for an object.

Default value: null, which represents that the default tooltip font in the system is used.

Since:

JTGO 4.0

See Also:

getToolTipText()

getToolTipForeground

Color getToolTipForeground()

Returns the text tooltip foreground color.

Default value: null, meaning that the default tooltip foreground color in the system is used.

Since:

JTGO 4.0

getToolTipBackground

Color getToolTipBackground()

Returns the text tooltip background color.

Default value: null, meaning that the default tooltip background color in the system is used.

Since:

JTGO 4.0

getGraphicRenderer

@Deprecated
IlpGraphicRenderer getGraphicRenderer()

Deprecated. Please use class property in your CSS files, defining the JComponent or IlvGraphic that will be used to represent the business attribute.

Returns the renderer used for creating the graphic representations of attributes.

Default value: none.

See Also:

IlpAttributeKeys.GraphicRenderer, IlvGraphic, IlvCompositeGraphic, JComponent

Deprecated Since:

JTGO 4.0

isVisibleInSystemWindow

boolean isVisibleInSystemWindow()

Returns whether an attribute should be added to the System Window or not. Attributes are only added to the System Window if this property value is true and is not represented by any other decoration.

Note: This property is only available for the Network and Equipment components

See Also:

IlpAttributeKeys.VisibleInSystemWindow

getCaptionLabel

String getCaptionLabel()

Denotes the text used as an attribute description in the System Window.

Default value: none.

Note: This property is only available for the Network and Equipment components

See Also:

IlpAttributeKeys.CaptionLabelString

isCaptionLabelVisible

boolean isCaptionLabelVisible()

Returns whether the label displayed in the header is visible.

Default value: Boolean.TRUE.

Note: This property is only available for the Network and Equipment components

See Also:

IlpAttributeKeys.CaptionLabelVisible

isUseDefaultCellRenderer

boolean isUseDefaultCellRenderer()

This property denotes the use of the default table cell renderer to render table cells.

This property only applies to the table component.

Returns:

Whether the default table cell renderer should be used or not.

Since:

JTGO 4.0

getCenteredInsets

@Deprecated
int getCenteredInsets()

Deprecated. Please use a composite graphic with a centered layout instead.

Returns the insets used when a graphic instance is added inside another component.

Default value: 0.

See Also:

IlpGraphic.CenteredInsets, IlpCentered, IlvCompositeGraphic, IlvCenteredLayout

Deprecated Since:

JTGO 4.0

getStackerSpacing

@Deprecated
int getStackerSpacing()

Deprecated. Please use a Composite Graphic with a Stacker Layout instead.

Returns the space between elements inside a stacker graphic.

Default value: 3.

See Also:

IlpGraphic.StackerSpacing, IlpStacker, IlvCompositeGraphic, IlvStackerLayout

Deprecated Since:

JTGO 4.0

getStackerOrientation

@Deprecated
int getStackerOrientation()

Deprecated. Please use a Composite Graphic with a Stacker Layout instead.

Returns the orientation of the stacker; in other words, the order that will be used to position the elements inside the stacker graphic. The possible values are:

• SwingConstants.TOP
• SwingConstants.BOTTOM
• SwingConstants.RIGHT
• SwingConstants.LEFT

Default value: javax.swing.SwingConstants.RIGHT

See Also:

IlpGraphic.StackerOrientation, IlpStacker, IlvCompositeGraphic, IlvStackerLayout

Deprecated Since:

JTGO 4.0

getStackerAlignment

@Deprecated
int getStackerAlignment()

Deprecated. Please use a Composite Graphic with a Stacker Layout instead.

Returns the alignment of the elements inside the stacker. The possible values are:

• SwingConstants.TOP
• SwingConstants.BOTTOM
• SwingConstants.RIGHT
• SwingConstants.LEFT
• SwingConstants.CENTER

Default value: javax.swing.SwingConstants.CENTER.

See Also:

IlpGraphic.StackerAlignment, IlpStacker, IlvCompositeGraphic, IlvStackerLayout

Deprecated Since:

JTGO 4.0

getInfoBalloonShadowThickness

@Deprecated
int getInfoBalloonShadowThickness()

Deprecated. Please use IlvRectBalloon instead.

Returns the thickness used to paint the shadow around the component.

See Also:

IlpGraphic.InfoBalloonShadowThickness,

Default value: 0.

Deprecated Since:

JTGO 4.0

getInfoBalloonPointerDepth

@Deprecated
int getInfoBalloonPointerDepth()

Deprecated. Please use IlvRectBalloon instead.

Returns the size of the balloon pointer.

Default value: 0.

See Also:

IlpGraphic.InfoBalloonPointerDepth, IlpInfoBalloon

Deprecated Since:

JTGO 4.0

getInfoBalloonOrientation

@Deprecated
int getInfoBalloonOrientation()

Deprecated. Please use IlvRectBalloon instead.

Returns the orientation of the balloon around its base graphic. The possible values are:

• SwingConstants.NORTH_EAST
• SwingConstants.NORTH_WEST
• SwingConstants.SOUTH_EAST
• SwingConstants.SOUTH_WEST
• SwingConstants.EAST
• SwingConstants.WEST

Default value: javax.swing.SwingConstants.NORTH_EAST.

See Also:

IlpGraphic.InfoBalloonOrientation, IlpInfoBalloon

Deprecated Since:

JTGO 4.0

getInfoBalloonColor

@Deprecated
Color getInfoBalloonColor()

Deprecated. Please use IlvRectBalloon instead.

Returns the background color used to paint the balloon graphic.

Default value: java.awt.Color.white.

Note: Blinking colors are not supported.

See Also:

IlpGraphic.InfoBalloonColor, IlpInfoBalloon

Deprecated Since:

JTGO 4.0

getInfoBalloonShadowColor

@Deprecated
Color getInfoBalloonShadowColor()

Deprecated. Please use IlvRectBalloon instead.

Returns the color used to paint the shadow in a balloon graphic.

Default value: java.awt.Color.white.

Note: Blinking colors are not supported.

See Also:

IlpGraphic.InfoBalloonShadowColor, IlpInfoBalloon

Deprecated Since:

JTGO 4.0

getInfoBalloonBorderColor

@Deprecated
Color getInfoBalloonBorderColor()

Deprecated. Please use IlvRectBalloon instead.

Returns the color used to paint the border in a balloon graphic.

Default value: java.awt.Color.black.

Note: Blinking colors are not supported.

See Also:

IlpGraphic.InfoBalloonBorderColor, IlpInfoBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonShadowThickness

@Deprecated
int getAlarmBalloonShadowThickness()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns the thickness used to paint the shadow around the component.

Default value: 0.

See Also:

IlpGraphic.AlarmBalloonShadowThickness, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonPointerDepth

@Deprecated
int getAlarmBalloonPointerDepth()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns the size of the balloon pointer.

Default value: 0.

See Also:

IlpGraphic.AlarmBalloonPointerDepth, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonOrientation

@Deprecated
int getAlarmBalloonOrientation()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns the orientation of the balloon around its base graphic. The possible values are:

• SwingConstants.NORTH_EAST
• SwingConstants.NORTH_WEST
• SwingConstants.SOUTH_EAST
• SwingConstants.SOUTH_WEST
• SwingConstants.EAST
• SwingConstants.WEST

Default value: javax.swing.SwingConstants.NORTH_EAST.

See Also:

IlpGraphic.AlarmBalloonOrientation, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonColor

@Deprecated
Color getAlarmBalloonColor()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns the background color used to paint the balloon graphic. This key is to be used in the style of a representation object or of an attribute.

Default value: Color.white.

Note: Blinking colors are not supported.

See Also:

IlpGraphic.AlarmBalloonColor, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonShadowColor

@Deprecated
Color getAlarmBalloonShadowColor()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns the color used to paint the shadow in a balloon graphic.

Default value: Color.white.

Note: Blinking colors are not supported.

See Also:

IlpGraphic.AlarmBalloonShadowColor, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonBorderColor

@Deprecated
Color getAlarmBalloonBorderColor()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns the color used to paint the border in a balloon graphic.

Default value: Color.black.

Note: Blinking colors are not supported.

See Also:

IlpGraphic.AlarmBalloonBorderColor, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonRadius

@Deprecated
int getAlarmBalloonRadius()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns the radius used to draw round rectangle balloons.

Default value: 0.

See Also:

IlpGraphic.AlarmBalloonRadius, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0

getAlarmBalloonPointerDistance

@Deprecated
int getAlarmBalloonPointerDistance()

Deprecated. Please use IlvRoundRectBalloon instead.

Returns distance from the left balloon face. By default, the alarm balloon pointer is displayed in the middle of the alarm balloon face. Setting this style value modifies the default behavior.

Default value: 0.

See Also:

IlpGraphic.AlarmBalloonPointerDistance, IlpAlarmBalloon

Deprecated Since:

JTGO 4.0