IlvPaletteSymbolParameter (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.symbology.palettes.IlvPaletteBaseObject
- - ilog.views.symbology.palettes.IlvPaletteSymbolParameter

All Implemented Interfaces:

Serializable
```
public class IlvPaletteSymbolParameter
extends IlvPaletteBaseObject
```
This class allows user to create an additional parameter that will be added to a symbol. A parameter is identified by its name, contains a value and defines the type of this value. To be more user friendly it provides a short and long description, and the class name of the editor that may be used to edit the value. (IlvPaletteSymbol).

Since:

JViews 8.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvPaletteSymbolParameter()` Default constructor.
`IlvPaletteSymbolParameter(String id, Object value, String type, String editor)` Creates a symbol parameter and initialize it with specified values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IlvPaletteSymbolParameter`	`copy()` Makes a copy of this symbol parameter.
`protected IlvPaletteBaseObject`	`copy(IlvPaletteBaseObject owner)` Makes a copy of this object.
`protected IlvPaletteBaseObject`	`createNew()` Allocates a new object of the same type.
`String`	`getEditorClassName()` Returns the class name of the editor that may be used to edit the value.
`IlvPalette`	`getPalette()` Returns the palette of the symbol the parameter belongs to.
`PropertyEditor`	`getPropertyEditor()` Allocates and returns the property editor for the parameter.
`IlvPaletteSymbol`	`getSymbol()` Returns the symbol the parameter belongs to.
`String`	`getType()` Returns the class name of the type of the value.
`Object`	`getValue()` Returns the value of the parameters.
`IlvPaletteSymbolParameterValueSet`	`getValueSet()` Returns the value set allowed for this symbol parameter.
`boolean`	`isReadOnly()` Returns `true` if this symbol parameter is considered a read only parameter.
`boolean`	`isVisible()` Returns `true` if this symbol parameter is considered visible.
`void`	`setEditorClassName(String editorClassName)` Sets the class name of the editor used to edit parameter's value.
`void`	`setID(String id)` Sets the ID of this parameter.
`void`	`setReadOnly(boolean enable)` Sets whether this symbol parameter is considered a read only parameter.
`void`	`setShortDescription(Locale locale, String description)` Sets the short description of the object for a given locale.
`void`	`setType(String type)` Sets the class name of the value type
`void`	`setValue(Object value)` Sets the value of this parameter.
`void`	`setValueSet(IlvPaletteSymbolParameterValueSet vset)` Returns the value set allowed for this symbol parameter.
`void`	`setVisible(boolean visible)` Sets whether this symbol parameter is considered visible.
`void`	`startEditingValueSet()` Starts an editing session of the value set.
`void`	`stopEditingValueSet()` Stops an editing session of the value set.

Methods inherited from class ilog.views.symbology.palettes.IlvPaletteBaseObject
getBaseObjectOwner, getDefaultLocale, getFullID, getID, getLongDescription, getLongDescription, getName, getName, getOwner, getShortDescription, getShortDescription, setDefaultLocale, setLongDescription, setLongDescription, setName, setName, setOwner, setShortDescription

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvPaletteSymbolParameter
```
public IlvPaletteSymbolParameter()
```
    Default constructor. Creates an instance of this class and initialize members with null values.
  - IlvPaletteSymbolParameter
```
public IlvPaletteSymbolParameter(String id,
                                 Object value,
                                 String type,
                                 String editor)
```
    Creates a symbol parameter and initialize it with specified values.
    
    Parameters:
    
    id - The id of the parameter.
    
    value - The value.
    
    type - The fully qualified name of the class of the value.
    
    editor - The fully qualified name of the class of the editor used to edit the value.
- Method Detail
  - copy
```
public IlvPaletteSymbolParameter copy()
```
    Makes a copy of this symbol parameter.
    
    Returns:
    
    the copy
  - copy
```
protected IlvPaletteBaseObject copy(IlvPaletteBaseObject owner)
```
    Makes a copy of this object. The copy is not owned by any owner, but it can later only be added to the input owner. You should not call this method.
    
    Overrides:
    
    copy in class IlvPaletteBaseObject
    
    Parameters:
    
    owner - The desired owner of the copy.
    
    Returns:
    
    the copy
  - createNew
```
protected IlvPaletteBaseObject createNew()
```
    Allocates a new object of the same type.
    
    Specified by:
    
    createNew in class IlvPaletteBaseObject
  - getSymbol
```
public IlvPaletteSymbol getSymbol()
```
    Returns the symbol the parameter belongs to.
  - getPalette
```
public IlvPalette getPalette()
```
    Returns the palette of the symbol the parameter belongs to.
  - setID
```
public void setID(String id)
```
    Sets the ID of this parameter. Note the the ID "palette" and "symbol" are reserved and cannot be used.
    
    Overrides:
    
    setID in class IlvPaletteBaseObject
    
    Parameters:
    
    id - the new id
  - setShortDescription
```
public void setShortDescription(Locale locale,
                                String description)
```
    Sets the short description of the object for a given locale. The short description is only a short line of text.
    
    Overrides:
    
    setShortDescription in class IlvPaletteBaseObject
    
    Parameters:
    
    locale - the locale used to store the description
    
    description - the new description
  - getType
```
public String getType()
```
    Returns the class name of the type of the value.
    
    Returns:
    
    a string representing the fully qualified name of the desired class. It returns the shortcuts "int", "boolean", etc. for the primitive types.
    
    See Also:
    
    getValue()
  - setType
```
public void setType(String type)
```
    Sets the class name of the value type
    
    Parameters:
    
    type - the fully qualified name of the class. The usual shortcuts "int", "boolean", etc. for the primitive types are also allowed.
    
    See Also:
    
    setValue(Object)
  - getValue
```
public Object getValue()
```
    Returns the value of the parameters. To know the exact type of this value, use getType() method
    
    Returns:
    
    the value
    
    See Also:
    
    getType()
  - setValue
```
public void setValue(Object value)
```
    Sets the value of this parameter. You should also set the type of this value by using setType(String type) method.
    
    Parameters:
    
    value - The new value.
    
    See Also:
    
    setType(String)
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns true if this symbol parameter is considered a read only parameter. Functionally, all parameters are writable. If the read only flag is set, it only means that the parameter appears non-editable in customizers and property sheets that control the symbol. But you will still be able to change the parameter by code.
    
    Returns:
    
    Whether the parameter is read only
    
    Since:
    
    JViews 8.8
  - setReadOnly
```
public void setReadOnly(boolean enable)
```
    Sets whether this symbol parameter is considered a read only parameter. Functionally, all parameters are writable. If the read only flag is set, it only means that the parameter appears non-editable in customizers and property sheets that control the symbol. But you will still be able to change the parameter by code.
    
    Since:
    
    JViews 8.8
  - isVisible
```
public boolean isVisible()
```
    Returns true if this symbol parameter is considered visible. If the visible flag is set to false, it only means that the parameter does not appear in customizers and property sheets that control the symbol.
    
    Returns:
    
    Whether the parameter is visible
    
    Since:
    
    JViews 8.8
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets whether this symbol parameter is considered visible. By default, all parameters are visible. If the visible flag is set to false, it only means that the parameter does not appear in customizers and property sheets that control the symbol.
    
    Since:
    
    JViews 8.8
  - getEditorClassName
```
public String getEditorClassName()
```
    Returns the class name of the editor that may be used to edit the value.
    
    Returns:
    
    The fully qualified name of the class. Can be null.
  - setEditorClassName
```
public void setEditorClassName(String editorClassName)
```
    Sets the class name of the editor used to edit parameter's value.
    
    Parameters:
    
    editorClassName - The fully qualified name of the desired class
  - getPropertyEditor
```
public PropertyEditor getPropertyEditor()
```
    Allocates and returns the property editor for the parameter. This property editor is locale-aware, i.e. it can be used in a GUI.
    If the parameter has an editor class name, a new instance of this editor class is allocated. If the parameter has a value set, a tagged property editor for the value set is returned. Otherwise, null is returned.
  - setValueSet
```
public void setValueSet(IlvPaletteSymbolParameterValueSet vset)
```
    Returns the value set allowed for this symbol parameter. If the parameter allows only a limited set of discrete values (like an enum type), a value set describing this set of allowed values is returned. If the parameter allows all values of the type obtained by getType(), null is returned.
    For instance, if the parameter allows all integer values, then getType() returns "int" and getValueSet() returns null. However, if the parameter allows only the integer values 3, 7, 19, then getType() returns "int" and getValueSet() returns a value set containing the values 3, 7, 19.
  - getValueSet
```
public IlvPaletteSymbolParameterValueSet getValueSet()
```
    Returns the value set allowed for this symbol parameter. If the parameter allows only a limited set of discrete values (like an enum type), a value set describing this set of allowed values is returned. If the parameter allows all values of the type obtained by getType(), null is returned.
    For instance, if the parameter allows all integer values, then getType() returns "int" and getValueSet() returns null. However, if the parameter allows only the integer values 3, 7, 19, then getType() returns "int" and getValueSet() returns a value set containing 3, 7, 19.
  - startEditingValueSet
```
public void startEditingValueSet()
```
    Starts an editing session of the value set. This should be called if the same value set is shared among multiple symbol parameters, and you want to make sure that changed on the value set only affects this parameter and no other parameter. This effectively unshares the current value set. Typical usage:
```
 param.startEditingValueSet();
 try {
   ... changes on the value set, such as:
   param.getValueSet().addValue(...);
   ...
 } finally {
   param.stopEditingValueSet();
 }
 
```
    Inside the try ... finally ... block, you should not save the palette to file, because the data structures are not in a saveable state. After param.stopEditingValueSet(), you can save the palette.
    See Also:
    
    stopEditingValueSet()
  - stopEditingValueSet
```
public void stopEditingValueSet()
```
    Stops an editing session of the value set. Must be called after startEditingValueSet. This tries to reshare the value set.
    
    See Also:
    
    startEditingValueSet()

Class IlvPaletteSymbolParameter

Constructor Summary

Method Summary

Methods inherited from class ilog.views.symbology.palettes.IlvPaletteBaseObject

Methods inherited from class java.lang.Object

Constructor Detail

IlvPaletteSymbolParameter

IlvPaletteSymbolParameter

Method Detail

copy

copy

createNew

getSymbol

getPalette

setID

setShortDescription

getType

setType

getValue

setValue

isReadOnly

setReadOnly

isVisible

setVisible

getEditorClassName

setEditorClassName

getPropertyEditor

setValueSet

getValueSet

startEditingValueSet

stopEditingValueSet