IlvPaletteSymbolParameterValueSet (Perforce JViews 10.0 API)

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

All Implemented Interfaces:

Serializable
```
public class IlvPaletteSymbolParameterValueSet
extends IlvPaletteBaseObject
```
This class represents a set of distinct values allowed for a symbol parameter. This is used if the symbol parameter does not allow all values of the given type (see IlvPaletteSymbolParameter.setType(java.lang.String)) but only a limited subset of distinct values (like an enum type). A value set can be shared among multiple parameters.
For convenience, the value set has methods to add float values, double values and integer values. All other types must be represented as Object values.

Since:

JViews 8.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IlvPaletteSymbolParameterValueSet(String id)
Default constructor.

Constructors
Constructor and Description
`IlvPaletteSymbolParameterValueSet(String id)` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValue(double value)` Adds a double to the value set.
`void`	`addValue(float value)` Adds a float to the value set.
`void`	`addValue(int value)` Adds an integer to the value set.
`void`	`addValue(Object value)` Adds an object to the value set.
`IlvPaletteSymbolParameterValueSet`	`copy()` Makes a copy of this symbol parameter value set.
`protected IlvPaletteBaseObject`	`copy(IlvPaletteBaseObject owner)` Makes a copy of this object.
`protected IlvPaletteBaseObject`	`createNew()` Allocates a new object of the same type.
`double[]`	`getDoubleValues()` Returns the value set if it is an double value set.
`float[]`	`getFloatValues()` Returns the value set if it is an float value set.
`int[]`	`getIntValues()` Returns the value set if it is an integer value set.
`Object[]`	`getObjectValues()` Returns the value set if it is an object value set.
`IlvPalette`	`getPalette()` Returns the palette of this object.
`PropertyEditor`	`getPropertyEditor(Locale locale)` Allocates and returns a property editor for this value set.
`String`	`getType()` Returns the class name of the type of the values in the value set.
`int`	`getUsageCount()` Returns how many parameters of symbols of the palette use this value set.
`String`	`getValueName(int index)` Returns the name of the value with given index for the default locale.
`String`	`getValueName(Locale locale, int index)` Returns the name of the value with given index for a given locale.
`boolean`	`isSame(IlvPaletteSymbolParameterValueSet vset)` Tests whether this value set is functionally equal to the input value set.
`void`	`removeValue(double value)` Removes a double from the value set.
`void`	`removeValue(float value)` Removes a float from the value set.
`void`	`removeValue(int value)` Removes an integer from the value set.
`void`	`removeValue(Object value)` Removes an object from the value set.
`void`	`setID(String id)` Sets the identifier of this object.
`void`	`setType(String type)` Sets the class name of the value type of the value set.
`void`	`setValueName(int index, String name)` Sets the name of the value with given index for the default locale.
`void`	`setValueName(Locale locale, int index, String name)` Sets the name of the value with given index for a given locale.
`void`	`setValues(double[] values)` Sets the value set as an double value set.
`void`	`setValues(float[] values)` Sets the value set as a float value set.
`void`	`setValues(int[] values)` Sets the value set as an integer value set.
`void`	`setValues(Object[] values)` Sets the value set as an object value set.
`int`	`size()` Returns the number of values 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, setShortDescription

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

- Constructor Detail
  - IlvPaletteSymbolParameterValueSet
```
public IlvPaletteSymbolParameterValueSet(String id)
```
    Default constructor. Creates an instance of this class and initialize members with null values.
- Method Detail
  - copy
```
public IlvPaletteSymbolParameterValueSet copy()
```
    Makes a copy of this symbol parameter value set.
    
    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
  - getPalette
```
public IlvPalette getPalette()
```
    Returns the palette of this object.
  - setID
```
public void setID(String id)
```
    Sets the identifier of this object. You should not call this method.
    
    Overrides:
    
    setID in class IlvPaletteBaseObject
    
    Parameters:
    
    id - the new identifier.
  - isSame
```
public boolean isSame(IlvPaletteSymbolParameterValueSet vset)
```
    Tests whether this value set is functionally equal to the input value set.
    
    Parameters:
    
    vset - The other value set.
    
    Returns:
    
    Whether both value sets represent the same values.
    
    Since:
    
    JViews 8.8
  - getType
```
public String getType()
```
    Returns the class name of the type of the values in the value set.
    
    Returns:
    
    a string representing the fully qualified name of the desired class. The usual shortcuts "int", "boolean", etc. for the primitive types are also allowed.
  - setType
```
public void setType(String type)
```
    Sets the class name of the value type of the value set. If integer, double or string values are added, it is not necessary to set the type explicitly, because the type is implicitly clear. In all other cases, the type of the value set must be set before using addValue(Object) or setValues(Object[]).
    
    Parameters:
    
    type - the fully qualified name of the class. The usual shortcuts "int", "boolean", etc. for the primitive types are also allowed.
  - getIntValues
```
public int[] getIntValues()
```
    Returns the value set if it is an integer value set. Returns null if it is not an integer value set.
  - setValues
```
public void setValues(int[] values)
```
    Sets the value set as an integer value set.
  - addValue
```
public void addValue(int value)
```
    Adds an integer to the value set. You cannot mix integer values and other value types in the same value set.
  - removeValue
```
public void removeValue(int value)
```
    Removes an integer from the value set.
  - getFloatValues
```
public float[] getFloatValues()
```
    Returns the value set if it is an float value set. Returns null if it is not an float value set.
  - setValues
```
public void setValues(float[] values)
```
    Sets the value set as a float value set.
  - addValue
```
public void addValue(float value)
```
    Adds a float to the value set. You cannot mix float values and other value types in the same value set.
  - removeValue
```
public void removeValue(float value)
```
    Removes a float from the value set.
  - getDoubleValues
```
public double[] getDoubleValues()
```
    Returns the value set if it is an double value set. Returns null if it is not an double value set.
  - setValues
```
public void setValues(double[] values)
```
    Sets the value set as an double value set.
  - addValue
```
public void addValue(double value)
```
    Adds a double to the value set. You cannot mix double values and other value types in the same value set.
  - removeValue
```
public void removeValue(double value)
```
    Removes a double from the value set.
  - getObjectValues
```
public Object[] getObjectValues()
```
    Returns the value set if it is an object value set. Returns null if it is not an object value set.
  - setValues
```
public void setValues(Object[] values)
```
    Sets the value set as an object value set. You should set the type of the value set before adding values.
  - addValue
```
public void addValue(Object value)
```
    Adds an object to the value set. You cannot mix object values and other value types in the same value set. You should set the type of the value set before adding values. Only for string types, it is not necessary to set the type.
  - removeValue
```
public void removeValue(Object value)
```
    Removes an object from the value set.
  - size
```
public int size()
```
    Returns the number of values of the value set.
  - setValueName
```
public void setValueName(Locale locale,
                         int index,
                         String name)
```
    Sets the name of the value with given index for a given locale.
    
    Parameters:
    
    locale - the locale used to store the description
    
    index - the index of the value in the value set
    
    name - the name.
  - getValueName
```
public String getValueName(Locale locale,
                           int index)
```
    Returns the name of the value with given index for a given locale.
    
    Parameters:
    
    locale - the locale
    
    index - the index of the value in the value set
  - setValueName
```
public void setValueName(int index,
                         String name)
```
    Sets the name of the value with given index for the default locale. You can use IlvPaletteBaseObject.setDefaultLocale(java.util.Locale) to change the locale under which the name is stored.
    
    Parameters:
    
    index - the index of the value in the value set
    
    name - the name
    
    See Also:
    
    IlvPaletteBaseObject.getDefaultLocale()
  - getValueName
```
public String getValueName(int index)
```
    Returns the name of the value with given index for the default locale. You can use IlvPaletteBaseObject.setDefaultLocale(java.util.Locale) to change the locale under which the name is looked up.
    
    Parameters:
    
    index - the index of the value in the value set
    
    See Also:
    
    IlvPaletteBaseObject.getDefaultLocale()
  - getUsageCount
```
public int getUsageCount()
```
    Returns how many parameters of symbols of the palette use this value set.
  - getPropertyEditor
```
public PropertyEditor getPropertyEditor(Locale locale)
```
    Allocates and returns a property editor for this value set. Returns null if the value set is empty, since in this case, a property editor makes no sense.
    
    Parameters:
    
    locale - The locale where this property editor works. Can be null.

Class IlvPaletteSymbolParameterValueSet

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

IlvPaletteSymbolParameterValueSet

Method Detail

copy

copy

createNew

getPalette

setID

isSame

getType

setType

getIntValues

setValues

addValue

removeValue

getFloatValues

setValues

addValue

removeValue

getDoubleValues

setValues

addValue

removeValue

getObjectValues

setValues

addValue

removeValue

size

setValueName

getValueName

setValueName

getValueName

getUsageCount

getPropertyEditor