IltNEBaseRenderer.General (Perforce JViews 10.0 API)

java.lang.Object
- ilog.tgo.graphic.renderer.IltBaseRenderer
- - ilog.tgo.graphic.renderer.IltNEBaseRenderer
  - - ilog.tgo.graphic.renderer.IltNEBaseRenderer.Graphic
    - - ilog.tgo.graphic.renderer.IltNEBaseRenderer.General

All Implemented Interfaces:

IltGraphicBaseRenderer

Enclosing class:

IltNEBaseRenderer
```
public static class IltNEBaseRenderer.General
extends IltNEBaseRenderer.Graphic
```
The base renderer for network elements of type General.

Nested Class Summary
- Nested classes/interfaces inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer
  IltNEBaseRenderer.BSC, IltNEBaseRenderer.BTS, IltNEBaseRenderer.BTSEquipment, IltNEBaseRenderer.ControlCluster, IltNEBaseRenderer.ControlComponent, IltNEBaseRenderer.ControlElement, IltNEBaseRenderer.EquipmentShape, IltNEBaseRenderer.General, IltNEBaseRenderer.Graphic, IltNEBaseRenderer.ManagementCluster, IltNEBaseRenderer.ManagementComponent, IltNEBaseRenderer.ManagementElement, IltNEBaseRenderer.MD, IltNEBaseRenderer.MSC, IltNEBaseRenderer.MuxShape, IltNEBaseRenderer.NE, IltNEBaseRenderer.NECluster, IltNEBaseRenderer.NEClusterLogical, IltNEBaseRenderer.NEComponent, IltNEBaseRenderer.NEComponentLogical, IltNEBaseRenderer.NELogical, IltNEBaseRenderer.NetworkShape, IltNEBaseRenderer.NMW, IltNEBaseRenderer.Server, IltNEBaseRenderer.StationShape, IltNEBaseRenderer.SwitchShape, IltNEBaseRenderer.TransportShape

Field Summary
- Fields inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer
  INVISIBLE_BASE_RENDERER

Constructor Summary

Constructors
Constructor and Description

General()

Constructors
Constructor and Description
`General()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`getBackground()` Returns the background color of the base.
`int`	`getBorderEndCap()` Returns the end cap style of the shape border.
`int`	`getBorderLineJoin()` Returns the line join style of the shape border.
`float`	`getBorderLineStylePhase()` Returns the dash phase of the shape border.
`float`	`getBorderMiterLimit()` Returns the miter limit of the shape border.
`Color`	`getFillColor2()` Returns the second color used to compute the gradient that fills the shape of the general node.
`Color`	`getForeground()` Returns the foreground color of the base.
`double`	`getHorizontalAutoResizeMargin()`
`int`	`getHorizontalAutoResizeMode()`
`String`	`getIcon()` Returns the icon of the general node.
`int`	`getIconPosition()` Returns the position of the icon with respect to the label.
`IlvGeneralNode`	`getNode()` Returns the graphic object that is displayed by this base renderer, an `IlvGeneralNode`.
`Dimension`	`getPreferredSize(boolean collapsed)` Returns the preferred size for this object.
`double`	`getShapeAspectRatio()` Returns the aspect ratio of the shape.
`double`	`getShapeHeight()` Returns the height of the shape.
`int`	`getShapeType()` Returns the type of shape for this general node.
`double`	`getShapeWidth()` Returns the width of the shape.
`double`	`getVerticalAutoResizeMargin()`
`int`	`getVerticalAutoResizeMode()`
`boolean`	`isKeepingAspectRatio()` Returns the flag that specifies whether the width/height ratio is preserved by the methods `setShapeWidth(double)` and `setShapeHeight(double)`.
`void`	`moveResize(IlvRect r)` Indicates that the underlying `IlvGraphic` must be displayed inside the given rectangle.
`void`	`setBackground(Color bg)` Sets the background color of the node shape.
`void`	`setBorderColor(Color v)` Sets the color of the stroke (that is, the border) of the node shape.
`void`	`setBorderEndCap(int v)` Sets the end cap style of the shape stroke.
`void`	`setBorderLineJoin(int v)` Sets the line join style of the shape border.
`void`	`setBorderLineStyle(IltLineStyle v)` Sets the line style of the shape border.
`void`	`setBorderLineStylePhase(float v)` Sets the dash phase of the shape border.
`void`	`setBorderMiterLimit(float v)` Sets the miter limit of the shape border.
`void`	`setBorderWidth(float v)` Sets the width of the shape stroke (that is, the border).
`void`	`setFillAngle(float v)` Sets the angle (in degrees) of the gradient used to fill the shape.
`void`	`setFillColor2(Color v)` Sets the second color used to compute the gradient that fills the shape of the general node.
`void`	`setFillEnd(float v)` Sets the position where the gradient ends, that is, where the color is the first color set by `setFillColor2(java.awt.Color)`.
`void`	`setFillStart(float v)` Sets the position where the gradient starts.
`void`	`setFillStyle(int v)` Sets the style used to fill the shape.
`void`	`setFillTexture(Image texture)` Sets the texture used to fill the shape of the general node.
`void`	`setForeground(Color c)` Sets the foreground color of the node shape.
`void`	`setHorizontalAutoResizeMargin(double v)`
`void`	`setHorizontalAutoResizeMode(int v)`
`void`	`setIcon(String url)` Sets the URL of the general node's icon.
`void`	`setIconPosition(int v)` Sets the position of the icon with respect to the label.
`void`	`setKeepingAspectRatio(boolean v)` Sets the flag that specifies whether the width/height ratio is preserved by the methods `setShapeWidth(double)` and `setShapeHeight(double)`.
`void`	`setShapeAspectRatio(double v)` Changes the aspect ratio of the shape.
`void`	`setShapeHeight(double v)` Changes the height of the shape.
`void`	`setShapeType(int v)` Changes the type of shape for this general node.
`void`	`setShapeWidth(double v)` Changes the width of the shape.
`void`	`setVerticalAutoResizeMargin(double v)`
`void`	`setVerticalAutoResizeMode(int v)`

Methods inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer.Graphic
boundingBox, containsMain, drawMain, getGraphic, isExtraBorderOutside, setGraphic

Methods inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer
createBaseRendererState, isCollapsed, setCollapsed

Methods inherited from class ilog.tgo.graphic.renderer.IltBaseRenderer
__isDottedBorderVisible, attach, boundingBoxWithTransformer, contains, containsExtraBorders, draw, drawAlarmBorder, drawExtraBorder, drawExtraBorder, drawExtraBorders, drawSelectionBorder, dropResources, getAlarmBorderColor, getAlarmBorderWidth, getAlarmColorLevel, getBaseRenderer, getBaseRendererState, getBorderColor, getBorderColor2, getBorderLineStyle, getBorderPalette, getBorderPattern, getBorderWidth, getBrightPalette, getDarkPalette, getDeprecatedBlinkingMode, getDetailLevel, getDottedBorderBackground, getDottedBorderForeground, getDottedBorderLineStyle, getDottedBorderPalette, getExtraBorders, getFillAngle, getFillEnd, getFillStart, getFillStyle, getFillTexture, getPalette, getPattern, getRepresentationObject, getSelectionBorderBackground, getSelectionBorderForeground, getSelectionBorderLineStyle, getSelectionBorderWidth, getSourceImage, getView, initBaseRenderer, initResources, isAlarmBorderVisible, isAlarmColorVisible, isBaseSelectionBorderVisible, isDottedBorderVisible, isPolygonalBorder, isReliefBorders, isUsingBlinkingResources, setAlarmBorderColor, setAlarmBorderVisible, setAlarmBorderWidth, setAlarmColorLevel, setAlarmColorVisible, setBaseRendererState, setBaseSelectionBorderVisible, setBorderColor2, setBorderPattern, setDeprecatedBlinkingMode, setDetailLevel, setDottedBorderBackground, setDottedBorderForeground, setDottedBorderLineStyle, setDottedBorderVisible, setPattern, setPolygonalBorder, setReliefBorders, setRepresentationObject, setSelectionBorderBackground, setSelectionBorderForeground, setSelectionBorderLineStyle, setSelectionBorderWidth, setSourceImage, setView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - General
```
public General()
```
- Method Detail
  - moveResize
```
public void moveResize(IlvRect r)
```
    Description copied from interface: IltGraphicBaseRenderer
    
    Indicates that the underlying IlvGraphic must be displayed inside the given rectangle.
    
    Specified by:
    
    moveResize in interface IltGraphicBaseRenderer
    
    Overrides:
    
    moveResize in class IltNEBaseRenderer.Graphic
    
    Parameters:
    
    r - Rectangle where the drawing will be performed
  - getPreferredSize
```
public Dimension getPreferredSize(boolean collapsed)
```
    Description copied from class: IltNEBaseRenderer.Graphic
    
    Returns the preferred size for this object. By default, the normal preferred size is the size of the IlvGraphic.
    
    Overrides:
    
    getPreferredSize in class IltNEBaseRenderer.Graphic
    
    Parameters:
    
    collapsed - Indicates that the network element is collapsed.
  - getNode
```
public final IlvGeneralNode getNode()
```
    Returns the graphic object that is displayed by this base renderer, an IlvGeneralNode.
  - setForeground
```
public void setForeground(Color c)
```
    Sets the foreground color of the node shape.
    
    Overrides:
    
    setForeground in class IltBaseRenderer
    
    Parameters:
    
    c - The new foreground color.
  - getForeground
```
public Color getForeground()
```
    Description copied from class: IltBaseRenderer
    
    Returns the foreground color of the base.
    The value depends on the semantic state of the object.
    This function is not meant to be overridden in subclasses.
    
    Overrides:
    
    getForeground in class IltBaseRenderer
  - setBackground
```
public void setBackground(Color bg)
```
    Sets the background color of the node shape.
    
    Overrides:
    
    setBackground in class IltBaseRenderer
    
    Parameters:
    
    bg - The new background color.
  - getBackground
```
public Color getBackground()
```
    Description copied from class: IltBaseRenderer
    
    Returns the background color of the base.
    The value depends on the semantic state of the object.
    
    Overrides:
    
    getBackground in class IltBaseRenderer
  - setBorderColor
```
public void setBorderColor(Color v)
```
    Sets the color of the stroke (that is, the border) of the node shape.
    
    Overrides:
    
    setBorderColor in class IltBaseRenderer
    
    Parameters:
    
    v - The new border color.
  - setBorderWidth
```
public void setBorderWidth(float v)
```
    Sets the width of the shape stroke (that is, the border). You can hide the border by setting the stroke width to -1.
    
    Overrides:
    
    setBorderWidth in class IltBaseRenderer
    
    Parameters:
    
    v - The new stroke width.
  - setBorderEndCap
```
public void setBorderEndCap(int v)
```
    Sets the end cap style of the shape stroke.
    The end cap style controls how the ends of the segments of the stroke will look when the stroke is dashed.
    Parameters:
    v - The new end cap style, which must be one of:
    
    java.awt.BasicStroke.CAP_BUTT
    
    java.awt.BasicStroke.CAP_ROUND
    
    java.awt.BasicStroke.CAP_SQUARE
  - getBorderEndCap
```
public int getBorderEndCap()
```
    Returns the end cap style of the shape border.
  - setBorderLineJoin
```
public void setBorderLineJoin(int v)
```
    Sets the line join style of the shape border. The line join style controls how the "angles" of the stroke will look.
    Parameters:
    v - The new line join style, which must be one of:
    
    java.awt.BasicStroke.JOIN_BEVEL
    
    java.awt.BasicStroke.JOIN_MITER
    
    java.awt.BasicStroke.JOIN_ROUND
  - getBorderLineJoin
```
public int getBorderLineJoin()
```
    Returns the line join style of the shape border.
  - setBorderMiterLimit
```
public void setBorderMiterLimit(float v)
```
    Sets the miter limit of the shape border. The miter limit controls how far the "angles" of the stroke are allowed to extend when the angle is very acute.
    
    Parameters:
    
    v - The new miter limit.
  - getBorderMiterLimit
```
public float getBorderMiterLimit()
```
    Returns the miter limit of the shape border.
  - setBorderLineStyle
```
public void setBorderLineStyle(IltLineStyle v)
```
    Sets the line style of the shape border.
    
    Overrides:
    
    setBorderLineStyle in class IltBaseRenderer
    
    Parameters:
    
    v - Line style
  - setBorderLineStylePhase
```
public void setBorderLineStylePhase(float v)
```
    Sets the dash phase of the shape border. This property can be used to adjust the positions of the dashes on the stroke. This is useful if the dashes do not look nice on the corners of the shape.
    
    Parameters:
    
    v - A float value that specifies the offset from the beginning of the stroke where the dash array pattern will start.
  - getBorderLineStylePhase
```
public float getBorderLineStylePhase()
```
    Returns the dash phase of the shape border.
  - setFillStyle
```
public void setFillStyle(int v)
```
    Sets the style used to fill the shape.
    
    Overrides:
    
    setFillStyle in class IltBaseRenderer
    
    Parameters:
    
    v - The fill style, which must be one of IlvGeneralNode.NO_FILL, IlvGeneralNode.SOLID_COLOR, IlvGeneralNode.LINEAR_GRADIENT, IlvGeneralNode.RADIAL_GRADIENT, or IlvGeneralNode.TEXTURE.
    
    See Also:
    
    IlFillStyle
  - setFillTexture
```
public void setFillTexture(Image texture)
```
    Sets the texture used to fill the shape of the general node.
    
    Overrides:
    
    setFillTexture in class IltBaseRenderer
    
    Parameters:
    
    texture - The URL of the image used as a texture.
  - setFillColor2
```
public void setFillColor2(Color v)
```
    Sets the second color used to compute the gradient that fills the shape of the general node.
    
    Parameters:
    
    v - The second color of the gradient.
  - getFillColor2
```
public Color getFillColor2()
```
    Returns the second color used to compute the gradient that fills the shape of the general node.
  - setFillStart
```
public void setFillStart(float v)
```
    Sets the position where the gradient starts.
    The default value is 0.
    
    Overrides:
    
    setFillStart in class IltBaseRenderer
    
    Parameters:
    
    v - A number between 0 and 1.
  - setFillEnd
```
public void setFillEnd(float v)
```
    Sets the position where the gradient ends, that is, where the color is the first color set by setFillColor2(java.awt.Color).
    The default value is 1.
    
    Overrides:
    
    setFillEnd in class IltBaseRenderer
    
    Parameters:
    
    v - A number between 0 and 1.
  - setFillAngle
```
public void setFillAngle(float v)
```
    Sets the angle (in degrees) of the gradient used to fill the shape.
    For a linear gradient, an angle of 0 means that the gradient goes from left to right (that is, the first color is on the left, and the second color on the right); an angle of 45 means that the gradient goes from the bottom to the top, and so on.
    For a radial gradient, the angle specifies the position of the center of the gradient relative to the center of the shape. The exact position of the center is also defined by the method setFillStart(float).
    Any angle between 0 and 360 can be used.
    The default value is 0.
    
    Overrides:
    
    setFillAngle in class IltBaseRenderer
    
    Parameters:
    
    v - An angle between 0 and 360.
  - setIcon
```
public void setIcon(String url)
```
    Sets the URL of the general node's icon. The contents of the URL can be:
    - a bitmap file,
    - an SVG file, or
    - a Perforce JViews prototype.
    Parameters:
    
    url - The new icon location.
  - getIcon
```
public String getIcon()
```
    Returns the icon of the general node.
  - setIconPosition
```
public void setIconPosition(int v)
```
    Sets the position of the icon with respect to the label. 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 is always at the center of the shape.
    
    Parameters:
    
    v - The new label position, which is one of the static fields of the IlvDirection interface.
  - getIconPosition
```
public int getIconPosition()
```
    Returns the position of the icon with respect to the label.
    
    Returns:
    
    One of the static fields of the IlvDirection interface.
    
    See Also:
    
    setIconPosition(int)
  - setShapeType
```
public void setShapeType(int v)
```
    Changes the type of shape for this general node.
    Parameters:
    v - The new shape type, which must be one of:
    IlvGeneralNode.RECTANGLE, IlvGeneralNode.ROUND_RECTANGLE, IlvGeneralNode.ELLIPSE, IlvGeneralNode.DIAMOND, IlvGeneralNode.TRIANGLE_UP, IlvGeneralNode.TRIANGLE_DOWN, IlvGeneralNode.TRIANGLE_LEFT, IlvGeneralNode.TRIANGLE_RIGHT, or IlvGeneralNode.MARKER
  - getShapeType
```
public int getShapeType()
```
    Returns the type of shape for this general node.
  - setShapeWidth
```
public void setShapeWidth(double v)
```
    Changes the width of the shape. The shape is scaled so that its width matches the specified size. If isKeepingAspectRatio() returns true, the height of the shape is also modified to keep the current aspect ratio. The center of the shape is always left unchanged.
    
    Parameters:
    
    v - The new width.
  - getShapeWidth
```
public double getShapeWidth()
```
    Returns the width of the shape.
  - setShapeHeight
```
public void setShapeHeight(double v)
```
    Changes the height of the shape. The shape is scaled so that its height matches the specified size. If isKeepingAspectRatio() returns true, the width of the shape is also modified to keep the current aspect ratio. The center of the shape is always left unchanged.
    Note that calling this method sets the "keep aspect ratio" flag to false.
    
    Parameters:
    
    v - The new height.
    
    See Also:
    
    setKeepingAspectRatio(boolean)
  - getShapeHeight
```
public double getShapeHeight()
```
    Returns the height of the shape.
  - setShapeAspectRatio
```
public void setShapeAspectRatio(double v)
```
    Changes the aspect ratio of the shape. The shape is scaled vertically so that the width/height ratio is equal to the specified value. The center of the shape is left unchanged.
    Note that calling this method sets the "keep aspect ratio" flag to true.
    
    Parameters:
    
    v - The new aspect ratio.
    
    See Also:
    
    setKeepingAspectRatio(boolean)
  - getShapeAspectRatio
```
public double getShapeAspectRatio()
```
    Returns the aspect ratio of the shape.
  - getHorizontalAutoResizeMode
```
public int getHorizontalAutoResizeMode()
```
    Internal: do not use!
  - setHorizontalAutoResizeMode
```
public void setHorizontalAutoResizeMode(int v)
```
    Internal: do not use!
  - setVerticalAutoResizeMode
```
public void setVerticalAutoResizeMode(int v)
```
    Internal: do not use!
  - getVerticalAutoResizeMode
```
public int getVerticalAutoResizeMode()
```
    Internal: do not use!
  - setHorizontalAutoResizeMargin
```
public void setHorizontalAutoResizeMargin(double v)
```
    Internal: do not use!
  - getHorizontalAutoResizeMargin
```
public double getHorizontalAutoResizeMargin()
```
    Internal: do not use!
  - setVerticalAutoResizeMargin
```
public void setVerticalAutoResizeMargin(double v)
```
    Internal: do not use!
  - getVerticalAutoResizeMargin
```
public double getVerticalAutoResizeMargin()
```
    Internal: do not use!
  - setKeepingAspectRatio
```
public void setKeepingAspectRatio(boolean v)
```
    Sets the flag that specifies whether the width/height ratio is preserved by the methods setShapeWidth(double) and setShapeHeight(double). If the flag is true, the dimensions of the shape are controlled by calling either setShapeWidth(double) or setShapeHeight(double), and by calling setShapeAspectRatio(double). If the flag is false, the dimensions of the shape are controlled by calling setShapeWidth(double) and setShapeHeight(double).
    Note that calling setShapeHeight(double) automatically sets the "keep aspect ratio" flag to false, and that calling setShapeAspectRatio(double) automatically sets the flag to true.
    
    Parameters:
    
    v - If true, the methods setShapeWidth(double) and setShapeHeight(double) will preserve the width/height ratio of the node shape. Otherwise, the width and the height can be set independently.
  - isKeepingAspectRatio
```
public boolean isKeepingAspectRatio()
```
    Returns the flag that specifies whether the width/height ratio is preserved by the methods setShapeWidth(double) and setShapeHeight(double).
    
    See Also:
    
    setKeepingAspectRatio(boolean)

Class IltNEBaseRenderer.General

Nested Class Summary

Nested classes/interfaces inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer

Field Summary

Fields inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer.Graphic

Methods inherited from class ilog.tgo.graphic.renderer.IltNEBaseRenderer

Methods inherited from class ilog.tgo.graphic.renderer.IltBaseRenderer

Methods inherited from class java.lang.Object

Constructor Detail

General

Method Detail

moveResize

getPreferredSize

getNode

setForeground

getForeground

setBackground

getBackground

setBorderColor

setBorderWidth

setBorderEndCap

getBorderEndCap

setBorderLineJoin

getBorderLineJoin

setBorderMiterLimit

getBorderMiterLimit

setBorderLineStyle

setBorderLineStylePhase

getBorderLineStylePhase

setFillStyle

setFillTexture

setFillColor2

getFillColor2

setFillStart

setFillEnd

setFillAngle

setIcon

getIcon

setIconPosition

getIconPosition

setShapeType

getShapeType

setShapeWidth

getShapeWidth

setShapeHeight

getShapeHeight

setShapeAspectRatio

getShapeAspectRatio

getHorizontalAutoResizeMode

setHorizontalAutoResizeMode

setVerticalAutoResizeMode

getVerticalAutoResizeMode

setHorizontalAutoResizeMargin

getHorizontalAutoResizeMargin

setVerticalAutoResizeMargin

getVerticalAutoResizeMargin

setKeepingAspectRatio

isKeepingAspectRatio