ilog.cpl.css
Interface IlpAttributeHeaderCustomization

All Known Subinterfaces:

IlpTableHeaderCustomization

public interface IlpAttributeHeaderCustomization

This interface contains properties that can be customized in order to define the graphic representation of a table attribute header in the JTGO Table Component.

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

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

Since:

JTGO 3.5

See Also:

IlpAttribute

Method Summary

Color	getBackground() Returns the background color of the label text in the header.
Color	getForeground() Returns the foreground color of the label text in the header.
int	getHorizontalAlignment() Returns the horizontal alignment of the label and icon within the table column header cell.
Image	getIcon() Returns the image used to create the icon in the header.
String	getLabel() Denotes the text used as a label in the header.
Font	getLabelFont() Returns the font used to display the label in the header.
int	getLabelInsets() Returns the distance (in pixels) from the label to its border.
int	getLabelPosition() Returns to the horizontal position of the text of the label, relative to the icon in the caption.
float	getLabelSpacing() Returns the gap between the text of the label and the icon.
int	getPreferredWidth() Returns the preferred width of a column in a table.
IlpSortingMode	getSortingMode() Returns whether this attribute is sorted in the table and, if so, in which direction.
int	getSortingPriority() Returns the priority of this attribute in the sorting process of the table.
String	getToolTipText() Returns the text used as tooltip in the header.
int	getVerticalAlignment() Returns the vertical alignment of the label and icon within the table column header cell.
boolean	isIconVisible() Returns whether the icon is visible in the header.
boolean	isLabelVisible() Returns whether the label displayed in the header is visible.
boolean	isSortingUsingDisplayValues() Returns whether the attribute is sorted using display values or raw values.
boolean	isVisible() Returns whether a column is visible in a table.

Method Detail

isVisible

boolean isVisible()

Returns whether a column is visible in a table.

Default value: true.

See Also:

IlpAttributeKeys.Visible

getPreferredWidth

int getPreferredWidth()

Returns the preferred width of a column in a table. The default width will be used if a negative value is specified.

Default value: -1.

See Also:

IlpAttributeKeys.PreferredWidth

getSortingMode

IlpSortingMode getSortingMode()

Returns whether this attribute is sorted in the table and, if so, in which direction.

Default value: IlpSortingMode.NONE.

See Also:

IlpAttributeKeys.SortingMode

getSortingPriority

int getSortingPriority()

Returns the priority of this attribute in the sorting process of the table.

Default value : 0.

See Also:

IlpAttributeKeys.SortingPriority

isSortingUsingDisplayValues

boolean isSortingUsingDisplayValues()

Returns whether the attribute is sorted using display values or raw values.

Default value : false.

See Also:

IlpAttributeKeys.SortingUsingDisplayValues

isLabelVisible

boolean isLabelVisible()

Returns whether the label displayed in the header is visible.

Default value: Boolean.TRUE.

See Also:

IlpAttributeKeys.CaptionLabelVisible

getLabel

String getLabel()

Denotes the text used as a label in the header.

Default value: none.

See Also:

IlpAttributeKeys.CaptionLabelString

getLabelFont

Font getLabelFont()

Returns the font used to display the label in the header.

Default value: none.

See Also:

IlpAttributeKeys.CaptionLabelFont

getLabelPosition

int getLabelPosition()

Returns to the horizontal position of the text of the label, relative to the icon in the caption. Valid values are:

• IlvDirection.Bottom
• IlvDirection.BottomLeft
• IlvDirection.BottomRight
• IlvDirection.Center
• IlvDirection.Horizontal
• IlvDirection.HorizontalCenter
• IlvDirection.Left
• IlvDirection.Right
• IlvDirection.Top
• IlvDirection.TopLeft
• IlvDirection.TopRight
• IlvDirection.Vertical
• IlvDirection.VerticalCenter

Default value: IlvDirection.Right

See Also:

IlpAttributeKeys.CaptionLabelPosition

getLabelSpacing

float getLabelSpacing()

Returns the gap between the text of the label and the icon.

Default value: 4.

See Also:

IlpAttributeKeys.CaptionLabelSpacing

getLabelInsets

int getLabelInsets()

Returns the distance (in pixels) from the label to its border.

Default value: 1.

See Also:

IlpAttributeKeys.CaptionLabelInsets

isIconVisible

boolean isIconVisible()

Returns whether the icon is visible in the header.

Default value: Boolean.TRUE.

See Also:

IlpAttributeKeys.CaptionIconVisible

getIcon

Image getIcon()

Returns the image used to create the icon in the header.

Default value: none.

See Also:

IlpAttributeKeys.CaptionIcon

getHorizontalAlignment

int getHorizontalAlignment()

Returns the horizontal alignment of the label and icon within the table column header cell. Valid values are:

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

Default value: javax.swing.SwingConstants.CENTER

See Also:

IlpAttributeKeys.CaptionHorizontalAlignment

getVerticalAlignment

int getVerticalAlignment()

Returns the vertical alignment of the label and icon within the table column header cell. Valid values are:

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

Default value: javax.swing.SwingConstants.CENTER

See Also:

IlpAttributeKeys.CaptionVerticalAlignment

getForeground

Color getForeground()

Returns the foreground color of the label text in the header.

Default value: none.

Note: Blinking colors are not supported.

See Also:

IlpAttributeKeys.CaptionLabelForegroundColor

getBackground

Color getBackground()

Returns the background color of the label text in the header.

Default value: none.

Note: Blinking colors are not supported.

See Also:

IlpAttributeKeys.CaptionLabelBackgroundColor

getToolTipText

String getToolTipText()

Returns the text used as tooltip in the header.

Default value: none.

See Also:

IlpAttributeKeys.CaptionToolTipString