ilog.views.dashboard

Class IlvDashboardSymbol

java.lang.Object

ilog.views.dashboard.IlvDashboardSymbol

All Implemented Interfaces:

Iterable<IlvDashboardSymbol.Parameter>

public class IlvDashboardSymbol
extends Object
implements Iterable<IlvDashboardSymbol.Parameter>

IlvDashboardSymbol is used to control symbols inside a dashboard diagram.

Overview

Rogue Wave JViews Symbols are created using the Rogue Wave JViews Symbol Editor graphical application. Symbols created using Symbol Editor are stored in collections called palettes. A standard symbol is defined by a IlvPaletteSymbol object stored in an IlvPalette instance. Once created, symbols are imported into dashboard diagrams by Dashboard Editor applications using The IlvDashboardSymbol class.

IlvDashboardSymbol controls the following aspect of a dashboard symbol:

• graphic objects contained in the symbol
• symbol size
• symbol position in a dashboard diagram
• symbol rendering
• symbol parameters

An IlvDashboardSymbol contains a standard IlvPaletteSymbol object; this symbol is rendered using a SDM Model object.

Link Symbols

A IlvDashboardSymbol instance takes two forms, standard symbols and links. A link is a specialized symbol used to connect two different symbols. Symbol links are linked to and from standard symbols and can optionally have intermediate points.

Parameters

An IlvDashboardSymbol instance gives you access to symbol parameters. You can retrieve, read and set all parameters for a symbol. A parameter can be mapped to an object property in the SDM Model object.

Example

The following code example shows the code to add a dashboard symbol dragged from a IlvDashboardSymbolPalette into an IlvDashboardDiagram instance.

 public class SymbolPaletteDropTargetDemo extends JFrame {
   IlvDashboardContext context;
   IlvDashboardDiagram dashboard;
   ...
   public void drop(DropTargetDropEvent dtde) {
     Transferable transferable = dtde.getTransferable();
     try {
       IlvPaletteDragAndDropData data = (IlvPaletteDragAndDropData) transferable.getTransferData(IlvPaletteObjectTransferable.PALETTE_OBJECT_FLAVOR);
       if (data != null && data.getPaletteObject() instanceof IlvPaletteSymbol) {
         IlvPaletteSymbol pSymb = (IlvPaletteSymbol) data.getPaletteObject();
         Point dropPoint = dtde.getLocation();
         IlvDashboardSymbol symbol = new IlvDashboardSymbol(dashboard, pSymb);
         dashboard.setAdjusting(true);
         try {
           dashboard.addSymbol(symbol);
           IlvTransformer transfo = dashboard.getView().getTransformer();
           IlvPoint point = new IlvPoint(dropPoint.x, dropPoint.y);
           if (transfo != null) {
             transfo.inverse(point);
           }
           Object modelObject = symbol.getModelObject();
           dashboard.setObjectProperty(modelObject, "x", new Double(point.x));
           dashboard.setObjectProperty(modelObject, "y", new Double(point.y));
         } finally {
             dashboard.setAdjusting(false);
         }
       }
     } catch (Exception e) {
           e.printStackTrace();
     }
   }
   ...
 }
 

Since:

JViews 8.0

See Also:

IlvDashboardDiagram, IlvDashboardEditorFrame, IlvSDMEngine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvDashboardSymbol.Parameter The IlvDashboardSymbol.Parameter class handles a single parameter for a IlvDashboardSymbol instance.
static interface	IlvDashboardSymbol.ParameterIterator Implement this interface to create an iterator for a collection of IlvDashboardSymbol parameters/

Constructor Summary

Constructors

Constructor and Description
IlvDashboardSymbol(IlvDashboardDiagram diagram, IlvPaletteSymbol paletteSymbol) Creates an instance of IlvDashboardSymbol defined by a specified palette symbol.
IlvDashboardSymbol(IlvDashboardDiagram diagram, IlvPaletteSymbol paletteSymbol, Object modelObject, String id, boolean defaultMapping) Creates an instance of IlvDashboardSymbol for a SDM model object.
IlvDashboardSymbol(IlvDashboardDiagram diagram, IlvPaletteSymbol paletteSymbol, String id) Creates an instance of IlvDashboardSymbol defined by a specified palette symbol, with a specific ID.
IlvDashboardSymbol(IlvDashboardDiagram diagram, IlvPaletteSymbol paletteSymbol, String id, boolean defaultMapping) Creates an instance of IlvDashboardSymbol defined by a specified palette symbol, with a specific ID, and with or without default parameter mappings.

Method Summary

Modifier and Type	Method and Description
PropertyEditor	createPropertyEditor(IlvDashboardSymbol.Parameter param) Returns a freshly created PropertyEditor for param.
IlvDashboardDiagram	getDiagram() Returns the IlvDashboardDiagram instance containing this symbol.
IlvGraphic	getGraphicObject() Returns the graphic object representing the symbol.
double	getHeight() Returns the height of this symbol.
String	getID() Returns the ID of this symbol.
IlvPoint[]	getIntermediateLinkPoints() Returns the intermediate points of a polyline link symbol.
IlvDashboardSymbol	getLinkFrom() Returns the source node symbol for a link symbol.
IlvDashboardSymbol	getLinkTo() Returns the target node symbol for a link symbol.
IlvSDMModel	getModel() Returns the SDM Model corresponding to the dashboard diagram of this symbol.
Object	getModelObject() Returns the SDM Model object.
IlvPaletteSymbol	getPaletteSymbol() Returns the palette symbol defining this dashboard symbol.
IlvPaletteSymbolParameter	getPaletteSymbolParameter(IlvDashboardSymbol.Parameter parameter) Returns the base IlvPaletteSymbolParameter parameter object defining parameter.
IlvDashboardSymbol.Parameter	getParameter(int index) Returns the symbol parameter at index in the list of parameters.
IlvDashboardSymbol.Parameter	getParameter(String id) Returns the parameter identified by id in the parameter list.
int	getParameterCount() Returns the number of the parameters in this symbol.
String	getParameterID(IlvDashboardSymbol.Parameter parameter) Returns the ID of parameter.
String	getParameterMapping(IlvDashboardSymbol.Parameter parameter) Returns the SDM object property mapping for parameter.
IlvDashboardSymbol.ParameterIterator	getParameters() Deprecated. You should use iterator() instead.
String	getParameterTextValue(IlvDashboardSymbol.Parameter param) Returns a string containing the value of param.
Object	getParameterValue(IlvDashboardSymbol.Parameter param) Returns the value of param.
Object	getParameterValue(int ndx) Returns the value of the parameter at ndx in the parameter collection.
Object	getParameterValue(String paramID) Returns the value of the parameter specified by paramID
PropertyEditor	getPropertyEditor(IlvDashboardSymbol.Parameter param) Returns the PropertyEditor for param.
IlvRect	getSymbolBoundingBox() Returns the bounding box of this symbol.
String	getTargetDashboardURL() Returns the target dashboard URL associated to this symbol.
double	getWidth() Returns the width of this symbol.
double	getX() Returns the x coordinate of this symbol.
double	getY() Returns the y coordinate of this symbol.
boolean	isLink() Tests if the symbol is a link.
boolean	isSelected() Tests if this symbol is selected in a dashboard diagram.
Iterator<IlvDashboardSymbol.Parameter>	iterator() Returns an iterator that you use to run over the collection of parameters contained in this dashboard symbol.
void	setHeight(double height) Sets the height for this symbol.
void	setID(String newID) Sets the ID of the symbol.
void	setIntermediateLinkPoints(IlvPoint[] points) Sets the intermediate points of a polyline link.
void	setLinkFrom(IlvDashboardSymbol fromSymbol) Sets the source node symbol for a link symbol.
void	setLinkTo(IlvDashboardSymbol toSymbol) Sets the target node symbol for a link symbol.
void	setParameterMapping(IlvDashboardSymbol.Parameter parameter, String mapping) Maps parameter to the mapping object property in the SDM model.
void	setParameterValue(IlvDashboardSymbol.Parameter parameter, Object value) Sets the value of parameter.
void	setParameterValue(String paramID, Object value) Sets the value of the parameter specified by paramID.
void	setSymbolBoundingBox(IlvRect rect) Move and resize this symbol.
void	setTargetDashboardURL(String target) Sets the target dashboard URL of this symbol.
void	setWidth(double width) Sets the width for this symbol.
void	setX(double x) Sets the x coordinate for this symbol.
void	setY(double y) Sets the y coordinate of this symbol.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IlvDashboardSymbol

public IlvDashboardSymbol(IlvDashboardDiagram diagram,
                          IlvPaletteSymbol paletteSymbol)

Creates an instance of IlvDashboardSymbol defined by a specified palette symbol.

Parameters:

diagram - The dashboard diagram for which this symbol is created.

paletteSymbol - The palette symbol which defines this new dashboard symbol.

See Also:

Overview, Example

IlvDashboardSymbol

public IlvDashboardSymbol(IlvDashboardDiagram diagram,
                          IlvPaletteSymbol paletteSymbol,
                          String id)

Creates an instance of IlvDashboardSymbol defined by a specified palette symbol, with a specific ID.

Parameters:

diagram - The dashboard diagram for which this symbol is created.

paletteSymbol - The palette symbol which defines this new dashboard symbol.

id - The ID for this new symbol.

See Also:

Overview, Example

IlvDashboardSymbol

public IlvDashboardSymbol(IlvDashboardDiagram diagram,
                          IlvPaletteSymbol paletteSymbol,
                          String id,
                          boolean defaultMapping)

Creates an instance of IlvDashboardSymbol defined by a specified palette symbol, with a specific ID, and with or without default parameter mappings. When a dashboard symbol is created, the values of its parameters can be automatically mapped to object properties of the SDM model with the same name. For example, a palette parameter value is mapped to a SDM property value.

Parameters:

diagram - The dashboard diagram for which this symbol is created.

paletteSymbol - The palette symbol which defines this new dashboard symbol.

id - The ID for this new symbol.

defaultMapping - Set to true so the parameters of this new symbol are mapped to the SDM model object properties with the same name.

See Also:

Overview, Example

IlvDashboardSymbol

public IlvDashboardSymbol(IlvDashboardDiagram diagram,
                          IlvPaletteSymbol paletteSymbol,
                          Object modelObject,
                          String id,
                          boolean defaultMapping)

Creates an instance of IlvDashboardSymbol for a SDM model object. The created symbol is defined by a specified palette symbol, with a specific ID, and with or without default parameter mappings.

If paletteSymbol is a link, modelObject must be a SDM link; if paletteSymbol is a node, modelObject must be an SDM node.

Note: modelObject must not be used by another dashboard symbol or directly added in your SDM model. The modelObject is added to the SDM model automatically when this dashboard symbol is added to diagram.

Parameters:

diagram - The dashboard diagram for which this symbol is created.

paletteSymbol - The palette symbol which defines this new dashboard symbol.

modelObject - The SDM model object encapsulated by this dashboard symbol.

id - The ID for this new symbol.

defaultMapping - Set to true so the parameters of this new symbol are mapped to the SDM model object properties with the same name.

Method Detail

getModel

public IlvSDMModel getModel()

Returns the SDM Model corresponding to the dashboard diagram of this symbol.

Returns:

The SDM Model.

getModelObject

public Object getModelObject()

Returns the SDM Model object.

Returns:

The SDM Model object.

See Also:

getModel(), Overview

getGraphicObject

public IlvGraphic getGraphicObject()

Returns the graphic object representing the symbol.

Returns:

The IlvGraphic object representing the symbol.

getPaletteSymbol

public IlvPaletteSymbol getPaletteSymbol()

Returns the palette symbol defining this dashboard symbol.

Returns:

The palette symbol used to create this dashboard symbol.

See Also:

IlvDashboardSymbol(IlvDashboardDiagram, IlvPaletteSymbol), Overview, Example

getParameters

@Deprecated
public IlvDashboardSymbol.ParameterIterator getParameters()

Deprecated. You should use iterator() instead.

Returns an iterator that you use to run over the collection of parameters contained in this dashboard symbol.

Returns:

An iterator for all parameters contained in this symbol.

iterator

public Iterator<IlvDashboardSymbol.Parameter> iterator()

Returns an iterator that you use to run over the collection of parameters contained in this dashboard symbol.

Specified by:

iterator in interface Iterable<IlvDashboardSymbol.Parameter>

Returns:

An iterator for all parameters contained in this symbol.

Since:

JViews 8.5

getParameterCount

public int getParameterCount()

Returns the number of the parameters in this symbol.

Returns:

The number of the parameters in this symbol.

See Also:

Overview, Parameters

getParameter

public IlvDashboardSymbol.Parameter getParameter(int index)

Returns the symbol parameter at index in the list of parameters.

Parameters:

index - The index of the parameter to be retrieved.

Returns:

The parameter at the position specified by index.

See Also:

Overview, Parameters

Internal: do not use!

getParameter

public IlvDashboardSymbol.Parameter getParameter(String id)

Returns the parameter identified by id in the parameter list.

Parameters:

id - The ID of the queried symbol parameter.

Returns:

The parameter specified by the id or null if this symbol does not contain a parameter with id.

See Also:

IlvDashboardSymbol(IlvDashboardDiagram, IlvPaletteSymbol, String), IlvDashboardSymbol(IlvDashboardDiagram, IlvPaletteSymbol, String, boolean), Overview, Parameters

getParameterMapping

public String getParameterMapping(IlvDashboardSymbol.Parameter parameter)

Returns the SDM object property mapping for parameter.

Parameters can have their value mapped to an object property of the SDM Model object. If parameter uses the default mapping, the SDM property has the same name as the parameter.

Parameters:

parameter - The parameter whose mapped SDM object property you need.

Returns:

The name of of the SDM Model object property mapped to parameter. Returns null if the parameter has not been mapped.

See Also:

setParameterMapping(Parameter, String), Overview, Parameters, IlvDashboardSymbol(IlvDashboardDiagram, IlvPaletteSymbol, String, boolean)

setParameterMapping

public void setParameterMapping(IlvDashboardSymbol.Parameter parameter,
                                String mapping)

Maps parameter to the mapping object property in the SDM model.

Parameters:

parameter - The parameter which is to mapped to mapping in the SDM model.

mapping - The object property in the SDM model to be mapped to parameter.

See Also:

getParameterMapping(Parameter), Overview, Parameters, IlvDashboardSymbol(IlvDashboardDiagram, IlvPaletteSymbol, String, boolean)

getParameterValue

public Object getParameterValue(int ndx)

Returns the value of the parameter at ndx in the parameter collection.

Parameters:

ndx - The index of the symbol parameter in the parameter collection.

Returns:

The value of the parameter.

See Also:

getParameter(String), Parameters

Internal: do not use!

getParameterValue

public Object getParameterValue(IlvDashboardSymbol.Parameter param)

Returns the value of param.

Parameters:

param - A symbol parameter.

Returns:

The value of param.

See Also:

Parameters

getParameterValue

public Object getParameterValue(String paramID)
                         throws IlvDashboardException

Returns the value of the parameter specified by paramID

Parameters:

paramID - The ID of the parameter.

Returns:

The value of the parameter.

Throws:

IlvDashboardException - if no parameter with the given ID is defined in this symbol.

Since:

JViews 8.1

See Also:

getParameterValue(Parameter), setParameterValue(String, Object)

getParameterTextValue

public String getParameterTextValue(IlvDashboardSymbol.Parameter param)

Returns a string containing the value of param.

Parameters:

param - A symbol parameter.

Returns:

The string value of param.

See Also:

Parameters

setParameterValue

public void setParameterValue(IlvDashboardSymbol.Parameter parameter,
                              Object value)

Sets the value of parameter.

Parameters:

parameter - A symbol parameter.

value - The new value for parameter.

See Also:

Parameters, getParameter(int), getParameter(String), getParameterMapping(Parameter), getParameterTextValue(Parameter)

setParameterValue

public void setParameterValue(String paramID,
                              Object value)
                       throws IlvDashboardException

Sets the value of the parameter specified by paramID.

Parameters:

paramID - The ID of the parameter.

value - The new value of the parameter.

Throws:

IlvDashboardException - if no parameter with the given ID is defined in this symbol.

Since:

JViews 8.1

See Also:

setParameterValue(Parameter, Object), getParameterValue(String)

getPaletteSymbolParameter

public IlvPaletteSymbolParameter getPaletteSymbolParameter(IlvDashboardSymbol.Parameter parameter)

Returns the base IlvPaletteSymbolParameter parameter object defining parameter.

Parameters:

parameter - A symbol parameter.

Returns:

The base palette parameter object relating to parameter.

See Also:

Parameters, getParameter(int), getParameter(String), getParameterMapping(Parameter), getParameterTextValue(Parameter)

getParameterID

public String getParameterID(IlvDashboardSymbol.Parameter parameter)

Returns the ID of parameter.

Parameters:

parameter - A symbol parameter.

Returns:

The parameter ID.

See Also:

Parameters, getParameter(int), getParameter(String), getParameterMapping(Parameter), getParameterTextValue(Parameter)

isLink

public boolean isLink()

Tests if the symbol is a link.

Returns:

True if the symbol is a link.

See Also:

Links

getDiagram

public IlvDashboardDiagram getDiagram()

Returns the IlvDashboardDiagram instance containing this symbol.

Returns:

The dashboard diagram containing this symbol.

getID

public String getID()

Returns the ID of this symbol.

The symbol ID is the same as the ID of the encapsulated SDM Model object.

Returns:

The ID of the symbol.

See Also:

setID(String)

setID

public void setID(String newID)
           throws IlvDashboardException

Sets the ID of the symbol.

Parameters:

newID - The new symbol ID.

Throws:

IlvDashboardException - if newID is already used by another symbol in the dashboard diagram.

See Also:

getID()

getPropertyEditor

public PropertyEditor getPropertyEditor(IlvDashboardSymbol.Parameter param)

Returns the PropertyEditor for param. This property editor is meant to be used for short periods of time.

Parameters:

param - A symbol parameter.

Returns:

The PropertyEditor for param, or null.

See Also:

Parameters

createPropertyEditor

public PropertyEditor createPropertyEditor(IlvDashboardSymbol.Parameter param)

Returns a freshly created PropertyEditor for param. This method can be used when the custom editor for this property editor is going to be displayed.

Parameters:

param - A symbol parameter.

Returns:

The PropertyEditor for param, or null.

Since:

JViews 8.1

See Also:

Parameters, getPropertyEditor(ilog.views.dashboard.IlvDashboardSymbol.Parameter)

getX

public double getX()

Returns the x coordinate of this symbol.

Returns:

The x coordinate of this symbol.

See Also:

setX(double), Overview

setX

public void setX(double x)

Sets the x coordinate for this symbol.

Parameters:

x - The new x coordinate.

See Also:

getX(), Overview

getY

public double getY()

Returns the y coordinate of this symbol.

Returns:

The y coordinate of this symbol.

See Also:

setY(double), Overview

setY

public void setY(double y)

Sets the y coordinate of this symbol.

Parameters:

y - The new y coordinate.

See Also:

getY(), Overview

getWidth

public double getWidth()

Returns the width of this symbol.

Returns:

The width of this symbol.

See Also:

getX(), getY(), setWidth(double), Overview

setWidth

public void setWidth(double width)

Sets the width for this symbol.

Parameters:

width - The new width for the symbol.

See Also:

getWidth(), setX(double), setY(double), Overview

getHeight

public double getHeight()

Returns the height of this symbol.

Returns:

The height of this symbol.

See Also:

setHeight(double), getWidth(), getX(), getY(), Overview

setHeight

public void setHeight(double height)

Sets the height for this symbol.

Parameters:

height - The new height for the symbol.

See Also:

getHeight(), Overview

getSymbolBoundingBox

public IlvRect getSymbolBoundingBox()

Returns the bounding box of this symbol.

Note: This bounding may be different from the bounding box of the graphic object returned by getGraphicObject.

Returns:

The bounding box rectangle of the symbol. Usually this bounding box is the size of the first child in the composite graphic representing the this symbol.

See Also:

getGraphicObject(), getModel(), setSymbolBoundingBox(IlvRect), Overview

setSymbolBoundingBox

public void setSymbolBoundingBox(IlvRect rect)

Move and resize this symbol. This is done by setting the x, y, width and height properties of the SDM model object.

Parameters:

rect - The rectangle that defines the new size and position of this symbol.

See Also:

Overview

getTargetDashboardURL

public String getTargetDashboardURL()

Returns the target dashboard URL associated to this symbol.

When a dashboard URL is associated to a dashboard symbol, that dashboard contents is opened automatically when the symbol is clicked by the user.

Returns:

the target dashboard URL associated to this symbol.

See Also:

IlvDashboardInteractor.showDashboard(String), setTargetDashboardURL(String)

setTargetDashboardURL

public void setTargetDashboardURL(String target)

Sets the target dashboard URL of this symbol.

When a dashboard URL is associated to a dashboard symbol, that dashboard contents is opened automatically when the symbol is clicked by the user.

Parameters:

target - The target dashboard URL to be attached to this symbol.

See Also:

IlvDashboardInteractor.showDashboard(String), getTargetDashboardURL()

setIntermediateLinkPoints

public void setIntermediateLinkPoints(IlvPoint[] points)

Sets the intermediate points of a polyline link.

Parameters:

points - The intermediate points.

See Also:

Overview, isLink()

getIntermediateLinkPoints

public IlvPoint[] getIntermediateLinkPoints()

Returns the intermediate points of a polyline link symbol.

Returns:

the intermediate points of a link.

See Also:

Links, isLink(), getLinkTo(), getLinkFrom(), setLinkTo(IlvDashboardSymbol), setLinkFrom(IlvDashboardSymbol)

getLinkFrom

public IlvDashboardSymbol getLinkFrom()

Returns the source node symbol for a link symbol.

Returns:

The symbol of origin this link symbol is attached to. Returns null if this symbol is not a link or it has no origin.

See Also:

getLinkTo(), isLink(), setLinkFrom(IlvDashboardSymbol), setLinkTo(IlvDashboardSymbol), Links

setLinkFrom

public void setLinkFrom(IlvDashboardSymbol fromSymbol)

Sets the source node symbol for a link symbol.

Parameters:

fromSymbol - The source symbol to connect to.

See Also:

getLinkFrom(), isLink(), Overview

getLinkTo

public IlvDashboardSymbol getLinkTo()

Returns the target node symbol for a link symbol.

Returns:

The target symbol this link symbol is attached to. Returns null if this symbol is not a link or it has no target node.

See Also:

getLinkFrom(), isLink(), setLinkFrom(IlvDashboardSymbol), setLinkTo(IlvDashboardSymbol), Links

setLinkTo

public void setLinkTo(IlvDashboardSymbol toSymbol)

Sets the target node symbol for a link symbol.

Parameters:

toSymbol - The target symbol to connect to.

See Also:

getLinkTo(), getLinkFrom(), isLink(), Overview

isSelected

public boolean isSelected()

Tests if this symbol is selected in a dashboard diagram.

Returns:

True if this symbol is selected.