ilog.views.sdm.renderer

Class IlvDecorationRenderer

java.lang.Object

ilog.views.sdm.renderer.IlvSDMRenderer

ilog.views.sdm.renderer.IlvFilterSDMRenderer

ilog.views.sdm.renderer.IlvDecorationRenderer

All Implemented Interfaces:

Serializable

public class IlvDecorationRenderer
extends IlvFilterSDMRenderer

The class IlvDecorationRenderer is a filtering renderer that adds various IlvGraphics in the manager.

The added objects are defined through a given style sheet (or through the style sheet of the IlvSDMEngine). To add graphic object, simply define names in this renderer (see setDecorationNames()) and it will try to load and add IlvGraphics corresponding to the names. The following example creates two filled rectangles and place them in the shape of an L with the corner at (0,0):

 SDM {
        Decoration : true;
 }
 
 Decoration {
        decorationNames : 'testV,testH';
 }
 
 // decorations
 
 #testH  {
    class       : 'ilog.views.interactor.IlvMakeFilledRectangleInteractor';
        IlvRect     : '10,20,100,2';
        x           : 0;
        y           : 0;
        layer       : 3;
        anchor      : TopLeft;
        foreground  : pink;
 }
 
 #testV  {
    class       : 'ilog.views.interactor.IlvMakeFilledRectangleInteractor';
        IlvRect     : '10,50,2,100';
        x           : 0;
        y           : 0;
        anchor      : BottomRight;
        layer       : 3;
 }
 

The renderer also has three properties used to fix the background color, the background pattern of the view, and to load an arbitrary .ivl file.

Since Perforce JViews version 8.0, this class can also load SVG and DXF files.

Since:

JViews 4.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.sdm.renderer.IlvFilterSDMRenderer

_renderer

Fields inherited from class ilog.views.sdm.renderer.IlvSDMRenderer

PSEUDOCLASS_PREFIX

Constructor Summary

Constructors

Constructor and Description
IlvDecorationRenderer() Creates a new decoration renderer with a null filtered renderer.
IlvDecorationRenderer(IlvSDMRenderer renderer) Creates a new decoration renderer for a specified filtered renderer.

Method Summary

Modifier and Type	Method and Description
Color	getBackground() Gets the background color.
URL	getBackgroundFile() Gets the background file.
URL	getBackgroundPatternLocation() Returns the location of the background pattern of the view.
int	getDebugMask() Returns the debug level of the current configuration style sheet.
String	getDecorationContext() Gets the decoration context.
String[]	getDecorationNames() Gets the names of the decoration objects.
String[]	getStyleSheets() Returns the current configuration style sheet.
String	getStyleSheets(int index) Returns the configuration style sheet found at location index in the array.
boolean	isFitToContent() Returns the value of the "fit-to-content" flag.
void	prepareRendering(IlvSDMEngine engine) Prepares the renderer for rendering objects in the specified SDM engine.
void	removeAll(IlvSDMEngine engine) Restores the original background color and pattern of the view.
void	renderingDone(IlvSDMEngine engine) Creates and adds the decoration object.
void	setBackground(Color color) Sets the view background color.
void	setBackgroundFile(URL ivlFile) Sets a URL that points to a Perforce JViews formatted file (.ivl).
void	setBackgroundPatternLocation(URL url) Changes the background pattern of the view.
void	setDebugMask(int v) Sets the CSS debug flag while parsing the configuration style sheet.
void	setDecorationContext(String context) Sets the decoration context (that is, an additional CSS class to match for all the decoration rules).
void	setDecorationNames(String[] names) Sets the names of the decoration objects.
void	setFitToContent(boolean fitToContent) Specifies whether a "fit-to-content" will be performed after the background file has been loaded.
void	setStyleSheets(int index, String v) Sets the configuration style sheet found at location index in the array.
void	setStyleSheets(String[] v) Sets the configuration style sheets.

Methods inherited from class ilog.views.sdm.renderer.IlvFilterSDMRenderer

addLinkGraphic, addNodeGraphic, computeBBox, createLinkGraphic, createNodeGraphic, customize, getEncapsulatedGraphic, getFilteredRenderer, getGraphicProperty, getLinkConnectionRectangle, linkGraphicAdded, moveResizeNodeGraphic, nodeGraphicAdded, nodeGraphicBBoxChanged, processServerAction, propertiesChanged, removeLinkGraphic, removeNodeGraphic, setFilteredRenderer, updateObjectProperties

Methods inherited from class ilog.views.sdm.renderer.IlvSDMRenderer

addViewListeners, callMoveResizeNodeGraphic, convert, convert, getAlias, getAuxiliaryBean, getAuxiliaryBeans, getEngine, getLinkConnectionRectangle, getLocation, getParameter, needsViewListeners, propertyChanged, removeViewListeners, setAlias, setEngine, setLayerName, setParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvDecorationRenderer

public IlvDecorationRenderer(IlvSDMRenderer renderer)

Creates a new decoration renderer for a specified filtered renderer.

Parameters:

renderer - The filtered renderer.

IlvDecorationRenderer

public IlvDecorationRenderer()

Creates a new decoration renderer with a null filtered renderer.

Method Detail

setDecorationNames

public void setDecorationNames(String[] names)

Sets the names of the decoration objects. These names are matched with the ID in the CSS.

Parameters:

names - The names of the decoration objects.

getDecorationNames

public String[] getDecorationNames()

Gets the names of the decoration objects.

setDecorationContext

public void setDecorationContext(String context)

Sets the decoration context (that is, an additional CSS class to match for all the decoration rules). It is then possible to trigger some of the decorations according to the context by adding the class to the rule selector.

Parameters:

context - The decoration context.

getDecorationContext

public String getDecorationContext()

Gets the decoration context.

setBackgroundFile

public void setBackgroundFile(URL ivlFile)
                       throws IOException,
                              IlvReadFileException

Sets a URL that points to a Perforce JViews formatted file (.ivl). The file contains Perforce JViews graphic objects that are added in the engine grapher only when IlvSDMEngine.loadData() is invoked.

Since Perforce JViews version 8.0, this class can also load SVG and DXF files.

Parameters:

ivlFile - The new background .ivl URL.

Throws:

IOException - An IO error occurs.

IlvReadFileException - This exception occurs when the grapher cannot read the file either because the file is not a Perforce JViews file, or because the format is not correct or some graphic classes cannot be found.

Since:

JViews 5.0

See Also:

IlvManager.read(java.net.URL)

getBackgroundFile

public URL getBackgroundFile()

Gets the background file.

Since:

JViews 5.0

isFitToContent

public boolean isFitToContent()

Returns the value of the "fit-to-content" flag.

Since:

JViews 6.5

See Also:

setFitToContent(boolean)

setFitToContent

public void setFitToContent(boolean fitToContent)

Specifies whether a "fit-to-content" will be performed after the background file has been loaded. This flag is effective only when a background file has been specified using setBackgroundFile(URL).

The default value is true.

Parameters:

fitToContent - If true, a "fit-to-content" will be performed after the background file has been loaded, otherwise the view's transformer will be left unchanged.

Since:

JViews 6.5

See Also:

isFitToContent()

setBackground

public void setBackground(Color color)

Sets the view background color.

Parameters:

color - The new background color.

See Also:

IlvManagerView.setBackground(java.awt.Color)

getBackground

public Color getBackground()

Gets the background color.

setBackgroundPatternLocation

public void setBackgroundPatternLocation(URL url)

Changes the background pattern of the view. The background pattern is an image that is used to fill the background of the view.

Parameters:

url - The URL of the image, or null to remove the pattern.

See Also:

getBackgroundPatternLocation(), IlvManagerView.setBackgroundPatternLocation(java.net.URL)

getBackgroundPatternLocation

public URL getBackgroundPatternLocation()

Returns the location of the background pattern of the view. The background pattern is an image that is used to fill the background of the view. This method may return null if the view has no background pattern.

See Also:

setBackgroundPatternLocation(java.net.URL)

setStyleSheets

public void setStyleSheets(String[] v)

Sets the configuration style sheets. If no style sheet is provided, the decoration renderer will fetch the style sheet of the SDM engine.

Parameters:

v - The array of style sheets (URL, filename, or string).

See Also:

setDebugMask(int), getStyleSheets(int)

setStyleSheets

public void setStyleSheets(int index,
                           String v)

Sets the configuration style sheet found at location index in the array. If no style sheet is provided, the decoration renderer will fetch the style sheet of the SDM engine.

Parameters:

index - The index of the style sheet in the array.

v - The style sheet (URL, filename, or string).

See Also:

setDebugMask(int), getStyleSheets(int)

getStyleSheets

public String getStyleSheets(int index)

Returns the configuration style sheet found at location index in the array.

Parameters:

index - The index of the style sheet in the array.

See Also:

setStyleSheets(java.lang.String[])

getStyleSheets

public String[] getStyleSheets()

Returns the current configuration style sheet.

See Also:

setStyleSheets(java.lang.String[])

setDebugMask

public void setDebugMask(int v)

Sets the CSS debug flag while parsing the configuration style sheet. Set this property before calling setStyleSheets() to debug problems during configuration. The default value will report bad class names.

Parameters:

v - The debug mask, as defined in IlvStyleSheetRenderer.

See Also:

IlvStyleSheetRenderer.setDebugMask(int), setStyleSheets(java.lang.String[]), getDebugMask()

getDebugMask

public int getDebugMask()

Returns the debug level of the current configuration style sheet.

See Also:

setDebugMask(int)

prepareRendering

public void prepareRendering(IlvSDMEngine engine)

Prepares the renderer for rendering objects in the specified SDM engine.

Overrides:

prepareRendering in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

removeAll

public void removeAll(IlvSDMEngine engine)

Restores the original background color and pattern of the view.

Overrides:

removeAll in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.

renderingDone

public void renderingDone(IlvSDMEngine engine)

Creates and adds the decoration object.

Overrides:

renderingDone in class IlvFilterSDMRenderer

Parameters:

engine - The SDM engine.