IlpObjectCustomization (ILOG JViews TGO 8.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS Documentation homepage NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ilog.cpl.css
Interface IlpObjectCustomization

All Known Subinterfaces:: IltObjectCustomization

public interface IlpObjectCustomization

This interface contains all the properties that can be customized in order to define the graphic representation of a business object in the different JTGO graphic components.

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

object."MyBusinessClass" {
  labelVisible: true;
  label: @name;
}

Since:: JTGO 3.5

Method Summary
`Color`	`getAlternateColor()` Sets the alternate color of an `IlvGeneralLink`.
`float`	`getAnimateSpeed()` Returns the animate speed of an `IlvGeneralLink`.
`Color`	`getArrowColor()` Returns the arrow color of an `IlvGeneralLink`.
`int`	`getArrowMode()` Returns the arrow drawing style of an `IlvGeneralLink`.
`float`	`getArrowPosition()` Returns the arrow position as the ratio of the link length of an `IlvGeneralLink`.
`float`	`getArrowRatio()` Returns the arrow size, as the proportion of the link length, of an `IlvGeneralLink`.
`Color`	`getBackground()` Returns the background color.
`Color`	`getBorderColor()` Returns the property denoting the primary color of a base border.
`Color`	`getBorderColor2()` Returns the property denoting the secondary color of a base border.
`Color`	`getBorderDownColor()` Deprecated. Please use `getBorderColor2` instead
`int`	`getBorderEndCap()` Sets the end cap style of the object border.
`int`	`getBorderLineJoin()` Returns the line join style of the object border.
`float[]`	`getBorderLineStyle()` Returns the property denoting the line style used to draw a base border.
`float`	`getBorderLineStylePhase()` Returns the dash phase of the object border.
`float`	`getBorderMiterLimit()` Returns the miter limit of the object border.
`float[]`	`getBorderStyle()` Deprecated. Please use `getBorderLineStyle` instead.
`float`	`getBorderStylePhase()` Deprecated. Please use `getBorderLineStylePhase` instead.
`Color`	`getBorderUpColor()` Deprecated. Please use `getBorderColor` instead.
`float`	`getBorderWidth()` Returns the border width.
`float`	`getCurved()` Returns the curved look and the smoothness of the spline of an `IlvGeneralLink`.
`int`	`getEndCap()` Returns the decorations applied at the end of the polyline of an `IlvGeneralLink`.
`float`	`getFillAngle()` Returns the angle (in degrees) of the gradient used to fill the shape of an object.
`Color`	`getFillColor2()` Deprecated. Please use property `background` instead.
`float`	`getFillEnd()` Returns the position where the gradient of an object ends, that is, where the color is the first color retrieved by `getBackground()`.
`float`	`getFillStart()` Returns the position where the gradient of an object starts, that is, where the color is the first color retrieved by `getForeground()`.
`int`	`getFillStyle()` Returns the style used to fill the shape of an object.
`Image`	`getFillTexture()` Returns the fill texture used to fill the shape of an object when property `fillStyle` is set as `IlFillStyle.TEXTURE`.
`Color`	`getFocusBorderColor()` Returns the color of the border of the object when it has focus.
`int`	`getFocusBorderWidth()` Returns the width of the focus border.
`Color`	`getForeground()` Returns the foreground color.
`IlpGraphicRenderer`	`getGraphicRenderer()` Deprecated. The `graphicRenderer` has been replaced by properties `class`, `children` and `constraints`. Please use `class` property to define a new graphic representation for your business object. Or use properties `children` and `constraints` if you just want to add new decorations to the predefined business objects.
`float`	`getHorizontalAutoResizeMargin()` Returns the margin that is left on both sides of the shape when it is autoresized horizontally.
`int`	`getHorizontalAutoResizeMode()` Returns the horizontal autoresize mode of an `IlvGeneralNode`.
`Image`	`getIcon()` Returns the image image that will be displayed as the icon in the graphical representation of the object.
`int`	`getIconPosition()` Returns the position of the icon with respect to the label of an `IlvGeneralNode`.
`IlpObjectInteractor`	`getInteractor()` Returns the object interactor currently set in this representation object.
`float`	`getInternalZoom()` Returns the internal scale factor of an `IlvGeneralLink`.
`String`	`getLabel()` Returns the text used as a label.
`int`	`getLabelAlignment()` Returns the alignment of multiline labels.
`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.
`float`	`getLabelMargin()` Sets the margin that will be kept between the labels and the edges of the shape when performing word wrapping or label truncation.
`int`	`getLabelPosition()` Returns the position of the text of the label relative to the icon.
`float`	`getLabelScaleFactor()` Returns the scale factor of the label, so that the label can be adjusted independently of the size of the shape.
`float`	`getLabelSpacing()` Returns the spacing between the shape and the label.
`boolean`	`getLabelStrikethrough()` Returns `true` if the text has strikethrough attribute.
`boolean`	`getLabelUnderline()` Sets the underline attribute of the label.
`float`	`getLabelWrappingHeight()` Sets the label wrapping height.
`short`	`getLabelWrappingMode()` Returns the wrapping mode of the text.
`float`	`getLabelWrappingWidth()` Returns the label wrapping width.
`int`	`getLineJoin()` Returns the decoration applied when two segments are joined.
`float`	`getLineSpacing()` Returns the spacing between the lines of multi-line labels.
`float[]`	`getLineStyle()` Returns the array representing the lengths of the dash segments.
`float`	`getLineStylePhase()` Returns the dash pattern offset.
`float`	`getLineWidth()` Returns the line width.
`int`	`getLinkLabelAllowedSide()` Returns the sides allowed for the label placement when a label layout is performed.
`float`	`getLinkLabelBottomOverlap()` Returns the number of pixels the bottom side of the label can overlap the related obstacle when a label layout is performed.
`float`	`getLinkLabelLeftOverlap()` Returns the number of pixels the left side of the label can overlap the related obstacle when a label layout is performed.
`float`	`getLinkLabelMaxDistFromPath()` Returns the maximal distance allowed between the label and the path when a label layout is performed.
`float`	`getLinkLabelMaxPercentageFromStart()` Returns the end point of the area of the polyline that should be used for the label when a label layout is performed.
`float`	`getLinkLabelMinPercentageFromStart()` Returns the start point of the area of the polyline that should be used for the label when a label layout is performed.
`float`	`getLinkLabelPreferredDistFromPath()` Returns the preferred distance between the label and the path when a label layout is performed.
`float`	`getLinkLabelPreferredPercentageFromStart()` Returns the percentage relative to the length of the polyline that defines the preferred position for the label.
`int`	`getLinkLabelPreferredSide()` Returns the preferred side where the label should be placed when a label layout is performed.
`float`	`getLinkLabelRightOverlap()` Returns the number of pixels the right side of the label can overlap the related obstacle when a label layout is performed.
`int`	`getLinkLabelSideAssociation()` Returns an association between the preferred and the allowed side for the label when a label layout is performed.
`float`	`getLinkLabelTopOverlap()` Returns the number of pixels the top side of the label can overlap the related obstacle when a label layout is performed.
`float`	`getMaxLabelZoom()` Returns the zoom level above which the label becomes invisible.
`float`	`getMaxLineWidth()` Returns the maximum line width while zooming out.
`float`	`getMinLabelZoom()` Returns the zoom level below which the label becomes invisible.
`float`	`getMinLineWidth()` Returns the minimum line width while zooming out.
`int`	`getMode()` Returns the link drawing mode.
`Image`	`getOverlapIcon()` Returns the image that will be used to create the overlap icon.
`int`	`getQualityLevel()` Returns the quality of the rendering of the link.
`IlpSelectionFocusMode`	`getSelectionFocusMode()` Returns the selection highlight mode to be used when rendering the selection and focus.
`float`	`getShapeAspectRatio()` Returns the aspect ratio of the shape of an `IlvGeneralNode`.
`float`	`getShapeHeight()` Returns the height of the shape.
`int`	`getShapeType()` Returns the shape of an `IlvGeneralNode`.
`float`	`getShapeWidth()` Returns the width of an off-page connector, a general node, ports, LEDs or the width of the object in logical representation.
`Color`	`getStrokeColor()` Deprecated. Please use `getBorderColor` instead.
`Float[]`	`getStrokeDashArray()` Deprecated. Please use `getBorderLineStyle` instead.
`float`	`getStrokeDashPhase()` Deprecated. Please use `getBorderLineStylePhase` instead.
`int`	`getStrokeEndCaps()` Deprecated. Please use `getBorderEndCap` instead.
`int`	`getStrokeLineJoins()` Deprecated. Please use `getBorderLineJoin` instead.
`float`	`getStrokeMiterLimit()` Deprecated. Please use `getBorderMiterLimit` instead.
`float`	`getStrokeWidth()` Deprecated. Please use `getBorderWidth` instead.
`Color`	`getSubnetworkBackground()` Returns the background color of a subnetwork.
`float`	`getSubnetworkBottomMargin()` Returns the bottom margin of the frame of a subnetwork.
`Font`	`getSubnetworkFont()` Returns the font used to draw the subnetwork title.
`Color`	`getSubnetworkForeground()` Returns the color of the frame around a subnetwork.
`IlpObjectFrameType`	`getSubnetworkFrame()` Returns the frame type of the subnetwork object.
`float`	`getSubnetworkLeftMargin()` Returns the left margin of the frame of a subnetwork.
`float`	`getSubnetworkMargin()` Deprecated. This property is no longer being used. Please use properties `subnetworkTopMargin`, `subnetworkBottomMargin`, `subnetworkLeftMargin` and `subnetworkRightMargin` instead.
`float`	`getSubnetworkRightMargin()` Returns the right margin of the frame of a subnetwork.
`String`	`getSubnetworkTitle()` Returns the title of a subnetwork.
`Color`	`getSubnetworkTitleColor()` Returns the title color of a subnetwork.
`int`	`getSubnetworkTitleJustification()` Returns the title justification of a subnetwork.
`float`	`getSubnetworkTopMargin()` Returns the top margin of the frame of a subnetwork.
`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.
`float`	`getVerticalAutoResizeMargin()` Returns the margin that is left on both sides of the shape when it is autoresized vertically.
`int`	`getVerticalAutoResizeMode()` Returns the vertical autoresize mode of an `IlvGeneralNode`.
`String`	`getWave()` Returns the wavy outline for the link.
`String`	`getWordWrapChars()` Deprecated. Property `wordWrapChars` is no longer supported. Word wrapping and truncate are now supported in all business classes, but the lines are separated according to the behavior defined in `BreakIterator`.
`float`	`getWordWrapMargin()` Deprecated. Please use `getLabelMargin` instead.
`Boolean`	`isIconVisible()` Returns whether the icon that is part of the graphic representation of the object will be visible.
`Boolean`	`isKeepingAspectRatio()` Returns the flag that specifies whether the width/height ratio is preserved by the properties `getShapeWidth()` and `getShapeHeight()`.
`Boolean`	`isLabelAntialiasing()` Returns whether the anti-aliasing mode of the label is set.
`Boolean`	`isLabelVisible()` Returns whether the label should be visible or not in the graphical representation of the object.
`Boolean`	`isLabelZoomable()` Deprecated. Labels are now zoomable according to the zoom policy defined in the Network and Equipment components.
`boolean`	`isMovable()` Returns whether the object can be moved or not through interactions.
`Boolean`	`isOriented()` Returns whether the link is oriented or nonoriented.
`Boolean`	`isOverlapIconVisible()` Returns whether the overlap icon will be displayed.
`Boolean`	`isSubnetworkCollapseIconVisible()` Returns whether the collapse icon is added to the detail objects of a subnetwork.
`Boolean`	`isSubnetworkExpansionIconVisible()` Returns whether the in-place expansion icon is added to the overview object of a subnetwork.
`Boolean`	`isSubnetworkOpaque()` Returns whether the subnetwork is opaque.
`Boolean`	`isSubnetworkShowingTitle()` Returns whether the subnetwork shows the title.
`Boolean`	`isWordWrapMode()` Deprecated. Please use `getLabelWrappingMode` instead. JTGO provides now support for word-wrapping and truncate for all business objects.

Method Detail

isMovable

boolean isMovable()

Returns whether the object can be moved or not through interactions.

This property is only available in the network and equipment components.

Since:: JTGO 4.0

isLabelVisible

Boolean isLabelVisible()

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

Default value: true

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.LabelVisible

getLabel

String getLabel()

Returns the text used as a label.

Default value: none

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.LabelString

getLabelFont

Font getLabelFont()

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

Default value: none

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.LabelFont

getLabelForeground

Color getLabelForeground()

Returns the foreground color of the label text.

Default value: none

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlpObjectKeys.LabelForegroundColor, IlpObjectKeys.SelectionForegroundColor

getLabelBackground

Color getLabelBackground()

Returns the background color of the label text.

Default value: none

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlpObjectKeys.LabelBackgroundColor, IlpObjectKeys.SelectionBackgroundColor

getLabelPosition

int getLabelPosition()

Returns the position of the text of the label relative to the icon. Valid values are:

Default value: IlvDirection.Bottom for the Network/Equipment components and IlvDirection.Right to the Tree component.

See Also:: IlpObjectKeys.LabelPosition

isLabelAntialiasing

Boolean isLabelAntialiasing()

Returns whether the anti-aliasing mode of the label is set.

Default value: true

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.LabelAntialiasing

getLabelSpacing

float getLabelSpacing()

Returns the spacing between the shape and the label.

Default value: 2.0f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.LabelSpacing

getLabelWrappingMode

short getLabelWrappingMode()

Returns the wrapping mode of the text.

The default value is IlvText.WRAP_NONE for the Network, Equipment and Tree components. This value is not used by the Table component.

Returns:

wrap One of the following values or a combination:

IlvText.WRAP_NONE : the text is displayed as-is.
IlvText.WRAP_WORD : the text is automatically broke into lines using a line instance java.text.BreakIterator which will break the text when appropriate to best fit getLabelWrappingWidth() width. For example in latin languages this will break the text at white spaces. To prevent the text from being broken at a particular white space you should use the Unicode non-breaking white space (' ').
IlvText.WRAP_TRUNCATE : the text is automatically truncated such that it fits getLabelWrappingHeight() height and getLabelWrappingWidth(). An ellipsis is added at the end of the truncated line.

Since:

JTGO 4.0

getLabelWrappingWidth

float getLabelWrappingWidth()

Returns the label wrapping width. This value is used when getLabelWrappingMode() is set to perform word-wrapping or truncation.

If this value is set to -1, the wrapping width will be automatically set as the width of the object base.

Since:: JTGO 4.0

getLabelWrappingHeight

float getLabelWrappingHeight()

Sets the label wrapping height. This value is used when getLabelWrappingMode() is set to perform word-wrapping or truncation.

If this value is set to -1, the wrapping height will be automatically set as the height of the object base.

Since:: JTGO 4.0

getLabelMargin

float getLabelMargin()

Sets the margin that will be kept between the labels and the edges of the shape when performing word wrapping or label truncation.

This property is used when the label wrapping height and width are automatically defined according to the object base.

Default value: 5f.

Since:: JTGO 4.0
See Also:: getLabelWrappingWidth(), getLabelWrappingHeight()

getLabelAlignment

int getLabelAlignment()

Returns the alignment of multiline labels. Valid values are:

Default
Left
Center
Right
Leading
Trailing

Setting this value to 0, resets the alignment to the default configuration.

This property is used in the Network and Equipment components.

Default value: Depends on the label position around the object base. If position is Bottom or Top, default alignment is IlvDirection.Center. If position is Left, alignment is IlvDirection.Right. If position is Right, alignment is IlvDirection.Left.

See Also:: IlpObjectKeys.LabelAlignment

getLineSpacing

float getLineSpacing()

Returns the spacing between the lines of multi-line labels.

Default value: -1

See Also:: IlpObjectKeys.LineSpacing

getLabelScaleFactor

float getLabelScaleFactor()

Returns the scale factor of the label, so that the label can be adjusted independently of the size of the shape.

Default value: 1f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.LabelScaleFactor

getMinLabelZoom

float getMinLabelZoom()

Returns the zoom level below which the label becomes invisible.

Default value: 1f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.MinLabelZoom

getMaxLabelZoom

float getMaxLabelZoom()

Returns the zoom level above which the label becomes invisible.

Default value: 500f

See Also:: IlpObjectKeys.MaxLabelZoom

getLabelStrikethrough

boolean getLabelStrikethrough()

Returns true if the text has strikethrough attribute.

Since:: JViews 7.5

getLabelUnderline

boolean getLabelUnderline()

Sets the underline attribute of the label.

Since:: JViews 7.5

isIconVisible

Boolean isIconVisible()

Returns whether the icon that is part of the graphic representation of the object will be visible.

Note: This property is valid for user-defined business objects that are represented in the Tree, Network or Equipment components. This property is also used by the group predefined business objects when displayed in the Network component.

Default value: true

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.IconVisible

getIcon

Image getIcon()

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

Default value: none

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.Icon

isOverlapIconVisible

Boolean isOverlapIconVisible()

Returns whether the overlap icon will be displayed.

Default value: true

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.OverlapIconVisible

getOverlapIcon

Image getOverlapIcon()

Returns the image that will be used to create the overlap icon.

Default value: none

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.OverlapIcon

getToolTipText

String getToolTipText()

Returns the text used as tooltip for an object.

Default value: none

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.ToolTipString

getToolTipFont

Font getToolTipFont()

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

Default value: null, meaning 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

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

getForeground

Color getForeground()

Returns the foreground color.

Default value: none

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlpObjectKeys.ForegroundColor

getBackground

Color getBackground()

Returns the background color.

Default value: node

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlpObjectKeys.BackgroundColor

getFocusBorderColor

Color getFocusBorderColor()

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

How the focus border is drawn depends on the selection focus mode.

Default value: node

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: getSelectionFocusMode(), IlpObjectKeys.FocusBorderColor

getFocusBorderWidth

int getFocusBorderWidth()

Returns the width of the focus border. How the focus border is drawn depends on the selection focus mode.

Default value: 1

Setting this property to -1, resets its value to the default one.

See Also:: getSelectionFocusMode(), IlpObjectKeys.FocusBorderThickness

getSelectionFocusMode

IlpSelectionFocusMode getSelectionFocusMode()

Returns the selection highlight mode to be used when rendering the selection and focus. See IlpSelectionFocusMode for valid values.

Default value:

In the Network and Equipment components : IlpSelectionFocusMode.BASE_SELECTION_FOCUS_MODE
In the Table component: IlpSelectionFocusMode.CELL_SELECTION_FOCUS_MODE
In the Tree component: IlpSelectionFocusMode.LABEL_SELECTION_FOCUS_MODE

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.SelectionFocusMode

getBorderWidth

float getBorderWidth()

Returns the border width.

This property is used to define the border width for custom and predefined business objects.

Default value: 2f for custom nodes and 0f for the other objects.

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.BorderWidth, IlpObjectKeys.StrokeWidth, IltObject.BorderWidth, IlvGeneralLink.setBorderWidth(float), IlvGeneralNode.setStrokeWidth(float)

getBorderColor

Color getBorderColor()

Returns the property denoting the primary color of a base border.

This property is used to define the primary border color for custom and predefined business objects.

Setting this property to null resets its value to the default one.

See Also:: IlpObjectKeys.BorderUpColor, IlpObjectKeys.StrokeColor, IltObject.BorderColor, IlvGeneralLink.setBorderUpColor(java.awt.Color), IlvGeneralNode.setStrokeColor(java.awt.Color)

getBorderColor2

Color getBorderColor2()

Returns the property denoting the secondary color of a base border.

This property is used to define the primary border color for custom and predefined business objects.

Setting this property to null resets its value to the default one.

See Also:: IlpObjectKeys.BorderDownColor, IltObject.BorderColor2, IlvGeneralLink.setBorderDownColor(java.awt.Color)

getBorderLineStyle

float[] getBorderLineStyle()

Returns the property denoting the line style used to draw a base border.

This property is mapped.

Setting this property to null resets its value to the default one.

See Also:: IlpObjectKeys.BorderStyle, IlpObjectKeys.StrokeDashArray, IltObject.BorderLineStyle, IlvGeneralLink.setBorderStyle(float[]), IlvGeneralNode.setStrokeDashArray(float[])

getBorderLineStylePhase

float getBorderLineStylePhase()

Returns the dash phase of the object border. This property can be used to adjust the positions of the dashes on the border. This is useful if the dashes do not look attractive on the corners of the shape.

The value is a float that specifies the offset from the beginning of the stroke where the dash array pattern will start.

Default value: 0

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.StrokeDashPhase, IlvGeneralNode.setStrokeDashPhase(float)

getBorderEndCap

int getBorderEndCap()

Sets the end cap style of the object border. The end cap style controls how the ends of the segments of the stroke will look when the stroke is dashed. Valid values for borderEndCap are:

Default value: BasicStroke.CAP_BUTT

See Also:: IlpObjectKeys.StrokeEndCaps, IlvGeneralNode.setStrokeEndCaps(int)

getBorderLineJoin

int getBorderLineJoin()

Returns the line join style of the object border.

The line join style controls how the "angles" of the stroke will look.

The line style must be one of:

Default value: BasicStroke.JOIN_MITER.

See Also:: IlpObjectKeys.StrokeLineJoins, IlvGeneralNode.setStrokeLineJoins(int)

getBorderMiterLimit

float getBorderMiterLimit()

Returns the miter limit of the object border.

The miter limit controls how far the "angles" of the stroke are allowed to extend when the angle is very acute.

Default value: 10

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.StrokeMiterLimit, IlvGeneralNode.setStrokeMiterLimit(float)

getAlternateColor

Color getAlternateColor()

Sets the alternate color of an IlvGeneralLink.

Default value: none

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlvGeneralLink.setAlternateColor(java.awt.Color), IlpObjectKeys.AlternateColor

getAnimateSpeed

float getAnimateSpeed()

Returns the animate speed of an IlvGeneralLink.

Default value: none

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.AnimateSpeed, IlvGeneralLink.setAnimateSpeed(float)

getArrowColor

Color getArrowColor()

Returns the arrow color of an IlvGeneralLink.

Default value: Color.black

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlpObjectKeys.ArrowColor, IlvGeneralLink.setArrowColor(java.awt.Color)

getArrowMode

int getArrowMode()

Returns the arrow drawing style of an IlvGeneralLink.

Default value: IlvGeneralLink.ARROW_FILL.

See Also:: IlpObjectKeys.ArrowMode, IlvGeneralLink.setArrowMode(int)

getArrowPosition

float getArrowPosition()

Returns the arrow position as the ratio of the link length of an IlvGeneralLink.

The default position is at the end of the link (value: 1f). Default value: 1f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.ArrowPosition, IlvGeneralLink.setArrowPosition(float)

getArrowRatio

float getArrowRatio()

Returns the arrow size, as the proportion of the link length, of an IlvGeneralLink.

Default value: 1f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.ArrowRatio, IlvGeneralLink.setArrowRatio(float)

getCurved

float getCurved()

Returns the curved look and the smoothness of the spline of an IlvGeneralLink.

Default value: 0f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.Curved, IlvGeneralLink.setCurved(float)

getEndCap

int getEndCap()

Returns the decorations applied at the end of the polyline of an IlvGeneralLink. Valid values are:

Default value: IlvStroke.CAP_SQUARE.

See Also:: IlpObjectKeys.EndCap, IlvGeneralLink.setEndCap(int)

getInternalZoom

float getInternalZoom()

Returns the internal scale factor of an IlvGeneralLink.

Default value: 1f.

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.InternalZoom, IlvGeneralLink.setInternalZoom(float)

getLineJoin

int getLineJoin()

Returns the decoration applied when two segments are joined. Valid values are:

Default value: IlvStroke.JOIN_MITER.

See Also:: IlpObjectKeys.LineJoin, IlvGeneralLink.setLineJoin(int)

getLineStyle

float[] getLineStyle()

Returns the array representing the lengths of the dash segments.

Default value: none

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.LineStyle, IlvGeneralLink.setLineStyle(float[])

getLineStylePhase

float getLineStylePhase()

Returns the dash pattern offset.

Default value: 0f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.LineStylePhase, IlvGeneralLink.setLineStylePhase(float)

getLineWidth

float getLineWidth()

Returns the line width.

This property is used for links and linear groups

Default value: 5f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.LineWidth, IltLinearGroup.Width, IlvGeneralLink.setLineWidth(float)

getMinLineWidth

float getMinLineWidth()

Returns the minimum line width while zooming out.

Note: This property is only used by the network and equipment components when rendering user-defined business objects as links.

Default value: 0f

See Also:: IlpObjectKeys.MinimumLineWidth, IlvGeneralLink.setMinimumLineWidth(float)

getMaxLineWidth

float getMaxLineWidth()

Returns the maximum line width while zooming out.

Note: This property is only used by the network and equipment components when rendering user-defined business objects as links.

Default value: 0f

Since:: JTGO 4.0
See Also:: IlvSimpleLink.setMaximumLineWidth(float)

getMode

int getMode()

Returns the link drawing mode. Caution: Do not use the border while in IlvGeneralLink.MODE_NEON. Valid values for IlpObject.Mode are:

Default value: IlvGeneralLink.MODE_GRADIENT.

See Also:: IlpObjectKeys.Mode, IlvGeneralLink.setMode(int)

getQualityLevel

int getQualityLevel()

Returns the quality of the rendering of the link. Modify this for faster interactions or high quality printing. Warning, this is a shared class property: all instances share the same value.

0:Link is rendered only as a single line.
1:MODE_UNICOLOR forced, no border, no wave effect, classic arrow.
2:1 + border.
3:All (default).
4:Very fine gradient spectra.
5:All BasicStroke with float value, no cache.

Default value: 3

See Also:: IlpObjectKeys.QualityLevel, IlvGeneralLink.setQualityLevel(int)

isOriented

Boolean isOriented()

Returns whether the link is oriented or nonoriented.

Default value: false

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.Oriented, IlvGeneralLink.setOriented(boolean)

getWave

String getWave()

Returns the wavy outline for the link. Use "0/0" to cancel the wavy effect. The value is a formatted string describing the wave. The format is "a/p", where "a" is an int representing the amplitude of the wave in pixels and "p" is an int representing the period (length) of the wave in pixels.

Default value: 0/0

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.Wave, IlvGeneralLink.setWave(java.lang.String)

getIconPosition

int getIconPosition()

Returns the position of the icon with respect to the label of an IlvGeneralNode. This property is effective only if the label position is equal to IlvDirection.Center, that is, if the label is inside the shape. If the label is outside the shape, the icon will always be at the center of the shape. The value is one of the static fields of the IlvDirection interface.

Default value: IlvDirection.Bottom

See Also:: IlpObjectKeys.IconPosition, IlvGeneralNode.setIconPosition(int)

getShapeType

int getShapeType()

Returns the shape of an IlvGeneralNode.

Default value: IlvGeneralNode.ROUND_RECTANGLE

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.ShapeType, IlvGeneralNode.setShapeType(int)

getShapeWidth

float getShapeWidth()

Returns the width of an off-page connector, a general node, ports, LEDs or the width of the object in logical representation.

Default value: 40

Setting this property to -1, resets its value to the default one.

See Also:: IltObject.LogicalWidth, IltOffPageConnector.Width, IlpObjectKeys.ShapeWidth, IlvGeneralNode.setShapeWidth(float)

getShapeHeight

float getShapeHeight()

Returns the height of the shape. This property is used in case of general nodes, Off-Page connectors, Ports, LEDs or objects in the logical representation.

Default value: 40

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.ShapeHeight, IlvGeneralNode.setShapeHeight(float)

getShapeAspectRatio

float getShapeAspectRatio()

Returns the aspect ratio of the shape of an IlvGeneralNode.

Default value: 0

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.ShapeAspectRatio, IlvGeneralNode.setShapeAspectRatio(float)

getHorizontalAutoResizeMode

int getHorizontalAutoResizeMode()

Returns the horizontal autoresize mode of an IlvGeneralNode.

Valid values are:

Default value: IlvGeneralNode.NO_AUTO_RESIZE

See Also:: IlpObjectKeys.HorizontalAutoResizeMode, IlvGeneralNode.setHorizontalAutoResizeMode(int)

getHorizontalAutoResizeMargin

float getHorizontalAutoResizeMargin()

Returns the margin that is left on both sides of the shape when it is autoresized horizontally.

Default value: 2

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.HorizontalAutoResizeMargin, IlvGeneralNode.setHorizontalAutoResizeMargin(float)

getVerticalAutoResizeMode

int getVerticalAutoResizeMode()

Returns the vertical autoresize mode of an IlvGeneralNode. Valid values are:

Default value: IlvGeneralNode.NO_AUTO_RESIZE

See Also:: IlpObjectKeys.VerticalAutoResizeMode, IlvGeneralNode.setVerticalAutoResizeMode(int)

getVerticalAutoResizeMargin

float getVerticalAutoResizeMargin()

Returns the margin that is left on both sides of the shape when it is autoresized vertically.

Default value: 2

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.VerticalAutoResizeMargin, IlvGeneralNode.setVerticalAutoResizeMargin(float)

getFillStyle

int getFillStyle()

Returns the style used to fill the shape of an object.

Valid values are:

Default value: IlFillStyle.SOLID_COLOR for custom business objects and patterns for predefined business objects. Please note that custom business objects do not support IlFillStyle.PATTERN, instead textures can be used.

See Also:: IlpObjectKeys.FillStyle, IlFillStyle

getFillTexture

Image getFillTexture()

Returns the fill texture used to fill the shape of an object when property fillStyle is set as IlFillStyle.TEXTURE.

Default value: none

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.FillTexture

getFillStart

float getFillStart()

Returns the position where the gradient of an object starts, that is, where the color is the first color retrieved by getForeground().

Default value: 0f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.FillStart

getFillEnd

float getFillEnd()

Returns the position where the gradient of an object ends, that is, where the color is the first color retrieved by getBackground().

Default value: 1f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.FillEnd

getFillAngle

float getFillAngle()

Returns the angle (in degrees) of the gradient used to fill the shape of an object.

Default value: 0f

Setting this property to -1, resets its value to the default one.

See Also:: IlpObjectKeys.FillAngle

isKeepingAspectRatio

Boolean isKeepingAspectRatio()

Returns the flag that specifies whether the width/height ratio is preserved by the properties getShapeWidth() and getShapeHeight(). If the flag is true, the dimensions of the shape are controlled by properties either shapeWidth or shapeHeight and by setting shapeAspectRatio.

Note that setting property shapeHeight explicitly sets the "keep aspect ratio" flag automatically to false, and that setting property shapeAspectRatio automatically sets the flag to true. If true, the properties shapeWidth and shapeHeight will preserve the width/height ratio of the node shape. Otherwise, the width and the height can be set independently.

Default value: true

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.KeepingAspectRatio, IlvGeneralNode.setKeepingAspectRatio(boolean)

getSubnetworkFrame

IlpObjectFrameType getSubnetworkFrame()

Returns the frame type of the subnetwork object.

Default value: IlpObjectFrameType.FILLED_RECTANGLE_FRAME

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectFrameType, IlpObjectKeys.SubnetworkFrame

getSubnetworkBackground

Color getSubnetworkBackground()

Returns the background color of a subnetwork.

Default value: none

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlpObjectKeys.SubnetworkBackgroundColor

getSubnetworkForeground

Color getSubnetworkForeground()

Returns the color of the frame around a subnetwork.

Default value: none

Setting this property to null, resets its value to the default one.

Note: Blinking colors are not supported.

See Also:: IlpObjectKeys.SubnetworkForegroundColor, IlpObjectFrameType.TITLEBAR_FRAME

getSubnetworkFont

Font getSubnetworkFont()

Returns the font used to draw the subnetwork title.

Default value: Dialog, plain, 12pt

Setting this property to null, resets its value to the default one.

Since:: JViews 7.5
See Also:: IlpObjectFrameType.TITLEBAR_FRAME

isSubnetworkOpaque

Boolean isSubnetworkOpaque()

Returns whether the subnetwork is opaque.

Default value: false

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.SubnetworkOpaque, IlpObjectFrameType.TITLEBAR_FRAME

isSubnetworkShowingTitle

Boolean isSubnetworkShowingTitle()

Returns whether the subnetwork shows the title.

Default value: true

Setting this property to null, resets its value to the default one.

See Also:: IlpObjectKeys.SubnetworkShowingTitle, IlpObjectFrameType.TITLEBAR_FRAME

getSubnetworkTitleColor

Color getSubnetworkTitleColor()

Returns the title color of a subnetwork.

Default value: none

Setting this property to n

ilog.cpl.css Interface IlpObjectCustomization

isMovable

isLabelVisible

getLabel

getLabelFont

getLabelForeground

getLabelBackground

getLabelPosition

isLabelAntialiasing

getLabelSpacing

getLabelWrappingMode

getLabelWrappingWidth

getLabelWrappingHeight

getLabelMargin

getLabelAlignment

getLineSpacing

getLabelScaleFactor

getMinLabelZoom

getMaxLabelZoom

getLabelStrikethrough

getLabelUnderline

isIconVisible

getIcon

isOverlapIconVisible

getOverlapIcon

getToolTipText

getToolTipFont

getToolTipForeground

getToolTipBackground

getToolTipGraphic

getForeground

getBackground

getFocusBorderColor

getFocusBorderWidth

getSelectionFocusMode

getBorderWidth

getBorderColor

getBorderColor2

getBorderLineStyle

getBorderLineStylePhase

getBorderEndCap

getBorderLineJoin

getBorderMiterLimit

getAlternateColor

getAnimateSpeed

getArrowColor

getArrowMode

getArrowPosition

getArrowRatio

getCurved

getEndCap

getInternalZoom

getLineJoin

getLineStyle

getLineStylePhase

getLineWidth

getMinLineWidth

getMaxLineWidth

getMode

getQualityLevel

isOriented

getWave

getIconPosition

getShapeType

getShapeWidth

getShapeHeight

getShapeAspectRatio

getHorizontalAutoResizeMode

getHorizontalAutoResizeMargin

getVerticalAutoResizeMode

getVerticalAutoResizeMargin

getFillStyle

getFillTexture

getFillStart

getFillEnd

getFillAngle

isKeepingAspectRatio

getSubnetworkFrame

getSubnetworkBackground

getSubnetworkForeground

ilog.cpl.css
Interface IlpObjectCustomization