ilog.tgo.graphic.renderer

Class IltOPCBaseRenderer.Graphic

java.lang.Object

ilog.tgo.graphic.renderer.IltBaseRenderer

ilog.tgo.graphic.renderer.IltOPCBaseRenderer

ilog.tgo.graphic.renderer.IltOPCBaseRenderer.Graphic

All Implemented Interfaces:

IltGraphicBaseRenderer

Enclosing class:

IltOPCBaseRenderer

public static class IltOPCBaseRenderer.Graphic
extends IltOPCBaseRenderer
implements IltGraphicBaseRenderer

The base renderer for off-page connectors that are displayed using IlvGraphic objects. This base renderer contains an IlvGraphic instance, which must be set at construction time. To use custom instances of IlvGraphic to represent off-page connectors you need to:

• Implement the IltBaseRendererFactory interface.
• Register it using IltSettings.SetValue(java.lang.Object, java.lang.Object).

In the implementation of createValue you should:

• Create a new instance of IltOPCBaseRenderer.Graphic.
• Create the IlvGraphic that will represent the off-page connector, along with its graphic properties.
• Set the IlvGraphic as the graphic of the off-page connector base renderer through Graphic.setGraphic.

The following example illustrates these steps:

  IltBaseRendererFactory factory = new IltBaseRendererFactory() {
    public IltBaseRenderer createValue() {
      IltOPCBaseRenderer.Graphic renderer = new IltOPCBaseRenderer.Graphic();
      IlvGraphic g = new IlvRectangle(new IlvRect(0,0,20,10));
      renderer.setGraphic(g);
      return renderer;
    }
  };
  IltSettings.SetValue("OffPageConnector.Type.YOUR_NEW_TYPE_NAME.Renderer" , factory );
 

This renderer uses the following properties defined for the object using cascading style sheets:

• shapeWidth: Denotes the width of the graphic representation.
• shapeHeight: Denotes the height of the graphic representation.

Nested Class Summary

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

IltOPCBaseRenderer.Clover, IltOPCBaseRenderer.Diamond, IltOPCBaseRenderer.Graphic, IltOPCBaseRenderer.Managed, IltOPCBaseRenderer.MultipleManaged, IltOPCBaseRenderer.MultipleUnmanaged, IltOPCBaseRenderer.SingleManaged, IltOPCBaseRenderer.SingleUnmanaged, IltOPCBaseRenderer.Standard, IltOPCBaseRenderer.Unmanaged

Constructor Summary

Constructors

Constructor and Description
Graphic()

Method Summary

Modifier and Type	Method and Description
IlvRect	boundingBox(IlvTransformer t, IlvRect rect, boolean withSelection) Returns the bounding box of the area that draw(g,t,rect) draws into.
protected boolean	containsMain(IlvPoint p, IlvPoint tp, IlvTransformer t, IlvRect rect) Tests whether a point lies within the main part of the base of this object.
protected void	drawMain(Graphics g, IlvTransformer t, IlvRect rect) Draws the main part of the base.
IlvGraphic	getGraphic() Returns the graphic instance that will be displayed by this base renderer.
void	moveResize(IlvRect r) Indicates that the underlying IlvGraphic must be displayed inside the given rectangle.
void	setGraphic(IlvGraphic g) Sets the graphic instance that will be displayed by this base renderer.

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

createBaseRendererState, getPreferredSize, isExtraBorderOutside, setPreferredSize

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

__isDottedBorderVisible, attach, boundingBoxWithTransformer, contains, containsExtraBorders, draw, drawAlarmBorder, drawExtraBorder, drawExtraBorder, drawExtraBorders, drawSelectionBorder, dropResources, getAlarmBorderColor, getAlarmBorderWidth, getAlarmColorLevel, getBackground, getBaseRenderer, getBaseRendererState, getBorderColor, getBorderColor2, getBorderLineStyle, getBorderPalette, getBorderPattern, getBorderWidth, getBrightPalette, getDarkPalette, getDeprecatedBlinkingMode, getDetailLevel, getDottedBorderBackground, getDottedBorderForeground, getDottedBorderLineStyle, getDottedBorderPalette, getExtraBorders, getFillAngle, getFillEnd, getFillStart, getFillStyle, getFillTexture, getForeground, getPalette, getPattern, getRepresentationObject, getSelectionBorderBackground, getSelectionBorderForeground, getSelectionBorderLineStyle, getSelectionBorderWidth, getSourceImage, getView, initBaseRenderer, initResources, isAlarmBorderVisible, isAlarmColorVisible, isBaseSelectionBorderVisible, isDottedBorderVisible, isPolygonalBorder, isReliefBorders, isUsingBlinkingResources, setAlarmBorderColor, setAlarmBorderVisible, setAlarmBorderWidth, setAlarmColorLevel, setAlarmColorVisible, setBackground, setBaseRendererState, setBaseSelectionBorderVisible, setBorderColor, setBorderColor2, setBorderLineStyle, setBorderPattern, setBorderWidth, setDeprecatedBlinkingMode, setDetailLevel, setDottedBorderBackground, setDottedBorderForeground, setDottedBorderLineStyle, setDottedBorderVisible, setFillAngle, setFillEnd, setFillStart, setFillStyle, setFillTexture, setForeground, 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

Graphic

public Graphic()

Method Detail

setGraphic

public final void setGraphic(IlvGraphic g)

Sets the graphic instance that will be displayed by this base renderer.

Parameters:

g - Graphic object.

getGraphic

public final IlvGraphic getGraphic()

Returns the graphic instance that will be displayed by this base renderer.

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

Parameters:

r - Rectangle where the drawing will be performed

drawMain

protected void drawMain(Graphics g,
                        IlvTransformer t,
                        IlvRect rect)

Description copied from class: IltBaseRenderer

Draws the main part of the base.

Specified by:

drawMain in class IltBaseRenderer

Parameters:

g - As in draw.

t - As in draw.

rect - As in draw.

containsMain

protected boolean containsMain(IlvPoint p,
                               IlvPoint tp,
                               IlvTransformer t,
                               IlvRect rect)

Description copied from class: IltBaseRenderer

Tests whether a point lies within the main part of the base of this object. This test should return true only if the point corresponds to a point drawn by the method drawMain.

This implementation returns true if the point tp is inside the rectangle rect, because it is assumed that the implementation of the drawMain method fills rect.

Note: This method may be overridden to take into account the shape drawn by this base renderer, if it is not rectangular or if it has transparency.

Note: The parameters tp and rect are given in the same coordinate system. The transformer t has already been applied to these parameters.

Overrides:

containsMain in class IltBaseRenderer

Parameters:

p - The point to be tested.

tp - The point p transformed by the transformer t.

t - The transformation that was applied to the object when it was drawn.

rect - As in draw.

See Also:

IltBaseRenderer.drawMain(java.awt.Graphics, ilog.views.IlvTransformer, ilog.views.IlvRect)

boundingBox

public IlvRect boundingBox(IlvTransformer t,
                           IlvRect rect,
                           boolean withSelection)

Description copied from class: IltBaseRenderer

Returns the bounding box of the area that draw(g,t,rect) draws into.

The argument rect is a fresh copy and may be destructively modified by this function.

This implementation of the function assumes that the main part fills rect. Depending on the value returned by isExtraBorderOutside(), the function returns rect, or rect enlarged by the width of the selection border, alarm border and dotted border, if present.

Overrides:

boundingBox in class IltBaseRenderer

Parameters:

t - Transformer applied to the object.

rect - As in draw.

withSelection - if false the rect will not be enlarged by the selection.