ilog.views.symbol.util

Interface IlvCompiledSymbol

public interface IlvCompiledSymbol

The common interface implemented by all compiled symbols generated by the Perforce JViews Symbol Compiler.

Since:

JViews 8.5

Method Summary

Modifier and Type	Method and Description
int	getLinkConnectionRectangleIndex() Returns the index of the composite child to be used as the link connection rectangle.
String	getParameterMapping(String paramID) Returns the mapped symbol property name of a parameter.
Iterator<String>	getParameterMappings() Returns the names of the properties mapped to the symbol parameters.
Object	getParameterValue(String paramID) Returns a parameter value.
Object	getSymbolProperty(String name) Returns a symbol property.
boolean	isAdjusting() Returns the adjusting state of a compiled symbol.
void	setAdjusting(boolean adjusting) Starts or stops a change sequence.
void	setParameterMapping(String paramID, String propertyName) Maps a parameter to a symbol property.
void	setParameterValue(String paramID, Object value) Sets a parameter value.
void	setSymbolProperty(String name, Object value) Sets a symbol property.

Method Detail

setAdjusting

void setAdjusting(boolean adjusting)

Starts or stops a change sequence.

Parameters:

adjusting - true to start, or false to stop a change sequence.

isAdjusting

boolean isAdjusting()

Returns the adjusting state of a compiled symbol.

Returns:

true if the symbol is in a change sequence state.

getParameterValue

Object getParameterValue(String paramID)

Returns a parameter value.

Parameters:

paramID - The ID of the parameter.

Returns:

The value of the parameter.

setParameterValue

void setParameterValue(String paramID,
                       Object value)

Sets a parameter value. If the parameter is mapped to a property, the mapped property is set.

Parameters:

paramID - The ID of the parameter.

value - The new value to be set to the parameter.

getParameterMapping

String getParameterMapping(String paramID)

Returns the mapped symbol property name of a parameter.

Parameters:

paramID - The ID of the parameter.

Returns:

The name of the mapped property name, or null if the parameter is not mapped.

setParameterMapping

void setParameterMapping(String paramID,
                         String propertyName)

Maps a parameter to a symbol property.

Parameters:

paramID - The ID of the mapped parameter.

propertyName - The name of the mapped symbol property.

getParameterMappings

Iterator<String> getParameterMappings()

Returns the names of the properties mapped to the symbol parameters.

Returns:

An iterator of the property names.

getSymbolProperty

Object getSymbolProperty(String name)

Returns a symbol property.

setSymbolProperty

void setSymbolProperty(String name,
                       Object value)

Sets a symbol property.

Parameters:

name - The property name.

value - The property value.

getLinkConnectionRectangleIndex

int getLinkConnectionRectangleIndex()

Returns the index of the composite child to be used as the link connection rectangle.

Returns:

The index of the link connection rectangle object.