ilog.views.dashboard

Class IlvDashboardSymbol.Parameter

java.lang.Object

ilog.views.dashboard.IlvDashboardSymbol.Parameter

Enclosing class:

IlvDashboardSymbol

public static class IlvDashboardSymbol.Parameter
extends Object

The IlvDashboardSymbol.Parameter class handles a single parameter for a IlvDashboardSymbol instance.

Since:

JViews 8.0

See Also:

IlvDashboardSymbol

Constructor Summary

Constructors

Constructor and Description
Parameter(IlvPaletteSymbolParameter param) Creates an IlvDashboardSymbol.Parameter instance that corresponds to param.

Method Summary

Modifier and Type	Method and Description
String	getID() Returns the ID of this symbol parameter.
IlvPaletteSymbolParameter	getPaletteSymbolParameter() Returns the IlvPaletteSymbolParameter instance defining this parameter.
boolean	isMapped() Tests if this Parameter is mapped.
boolean	isReadOnly() Returns true if the symbol parameter is read-only while the symbol is being edited in the Dashboard Editor.
boolean	isVisible() Returns true if this symbol parameter appears in the Dashboard Editor parameter table while the symbol is edited.
void	setReadOnly(boolean readOnly) Specifies whether this symbol parameter should be read-only while the symbol is edited in the Dashboard Editor.
void	setVisible(boolean visible) Specifies whether this symbol parameter should appear in the Dashboard Editor parameter table while the symbol is edited.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(IlvPaletteSymbolParameter param)

Creates an IlvDashboardSymbol.Parameter instance that corresponds to param.

Parameters:

param - A standard symbol parameter.

Method Detail

getPaletteSymbolParameter

public IlvPaletteSymbolParameter getPaletteSymbolParameter()

Returns the IlvPaletteSymbolParameter instance defining this parameter.

Returns:

The palette symbol parameter.

isMapped

public boolean isMapped()

Tests if this Parameter is mapped.

Returns:

true if this parameter is mapped.

getID

public String getID()

Returns the ID of this symbol parameter.

Returns:

The ID of this symbol parameter.

isReadOnly

public boolean isReadOnly()

Returns true if the symbol parameter is read-only while the symbol is being edited in the Dashboard Editor.

Returns:

The read-only flag for this symbol parameter.

Since:

JViews 8.8

setReadOnly

public void setReadOnly(boolean readOnly)

Specifies whether this symbol parameter should be read-only while the symbol is edited in the Dashboard Editor.

Parameters:

readOnly - If true, sets this symbol parameter as read-only.

Since:

JViews 8.8

isVisible

public boolean isVisible()

Returns true if this symbol parameter appears in the Dashboard Editor parameter table while the symbol is edited.

Returns:

Visibility attribute of this parameter in the parameter table.

Since:

JViews 8.8

setVisible

public void setVisible(boolean visible)

Specifies whether this symbol parameter should appear in the Dashboard Editor parameter table while the symbol is edited.

Parameters:

visible - If true, displays this parameter in the parameter table.

Since:

JViews 8.8