IlvPalette (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.symbology.palettes.IlvPalette

```
public class IlvPalette
extends Object
```
A palette is a collection of symbols that could be grouped into a hierarchy of categories. The description of a palette is stored into a jar file containing an XML file describing the content of the palette as a set of categories and symbols, property files, css files for each symbol and images files for the symbols. This class represents the content of a palette.

Since:

JViews 8.0

See Also:

IlvPaletteSymbol, IlvPaletteCategory

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PALETTE_DESCRIPTION_FILE` Constant defining the name of the xml file containing palette's description: "palette.xml"
`static int`	`SMALLICON_SIZE` size of small icon representing the palette

Constructor Summary

Constructors
Constructor and Description

IlvPalette()
Creates a new palette.

IlvPalette(ClassLoader classLoader)
Creates a new palette.

Constructors
Constructor and Description
`IlvPalette()` Creates a new palette.
`IlvPalette(ClassLoader classLoader)` Creates a new palette.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IlvPaletteCategory`	`addCategory(IlvPaletteCategory parent, String categoryID)` Add a category in the palette.
`void`	`addPaletteListener(PaletteListener l)` Adds a listener that listens to palette events.
`IlvPaletteSymbol`	`addSymbol(IlvPaletteCategory parent, String symbolID)` Add a symbol in the palette.
`String`	`addValueSet(IlvPaletteSymbolParameterValueSet vset, boolean checkDuplicates)` Adds a value set to this palette.
`protected void`	`fireCategoryAdded(IlvPaletteCategory parent, IlvPaletteCategory category)` Fire an event when adding category to the category hierarchy.
`protected void`	`fireCategoryRemoved(IlvPaletteCategory parent, IlvPaletteCategory category)` Fire an event when removing a category from the category hierarchy.
`protected void`	`fireSymbolAdded(IlvPaletteCategory parent, IlvPaletteSymbol symbol)` Fire an event when adding a symbol into a category.
`protected void`	`fireSymbolRemoved(IlvPaletteCategory parent, IlvPaletteSymbol symbol)` Fire an event when removing a symbol from a category.
`protected void`	`fireValueSetAdded(IlvPaletteSymbolParameterValueSet vset)` Fire an event when adding a value set to the palette.
`protected void`	`fireValueSetRemoved(IlvPaletteSymbolParameterValueSet vset)` Fire an event when removing a value set from the palette.
`IlvPaletteCategory`	`getCategory(String path)` Returns the first occurrence of a category matching the specified path.
`int`	`getChildCount(Object parent)` Returns the number of children in the specified parent
`Enumeration`	`getChildren(Object parent)` Returns and enumeration of the children of the specified parent.
`Locale`	`getDefaultLocale()` Returns the locale used to store name and description.
`String`	`getDescription()` Returns the palette description for the default locale.
`String`	`getDescription(Locale locale)` Returns the palette description for a given locale.
`Icon`	`getIcon()` Gets the icon associated to the palette
`String`	`getIconResourceName()` Returns the resource access string to the symbol icon
`URL`	`getIconURL()` Returns the string representation of the URL to the icon
`URL`	`getJarURL()` Returns the URL to the palette jar file.
`String`	`getName()` Returns the palette name for the default locale.
`String`	`getName(Locale locale)` Returns the palette name for a given locale.
`String`	`getPackageName()` Returns the package name in which the palette.xml file is located.
`IlvPaletteObject`	`getPaletteObject(String path)` Returns the first occurrence of a category or symbol matching the specified path.
`String`	`getPaletteResourceName()` Returns the resource access name to palette.xml.
`URL`	`getPaletteURL()` Returns URL to access palette.xml
`Object`	`getParent(Object object)` Returns the parent of the specified object.
`IlvPaletteCategory`	`getRoot()` Returns the root category of this palette
`ImageIcon`	`getSmallIcon()` Gets the small size icon representing the palette
`IlvPaletteSymbol`	`getSymbol(String path)` Returns the first occurrence of a symbol matching the specified path.
`IlvPaletteSymbol`	`getSymbol(String cssResourceName, String className)` Returns the first occurrence of a symbol that has the specified CSS resource name and the specified class name.
`IlvPaletteSymbolParameterValueSet`	`getValueSet(int index)` Returns the value set with the given index.
`IlvPaletteSymbolParameterValueSet`	`getValueSet(String id)` Returns the value set with the given ID.
`int`	`getValueSetCount()` Returns the number of value sets of this palette.
`IlvPaletteSymbolParameterValueSet[]`	`getValueSets()` Returns all value sets added to this palette.
`boolean`	`isCategory(Object object)` Indicates if the specified object is an instance of IlvPaletteCategory
`void`	`load(URL urlOfPaletteXml)` Loads a palette by reading the content of the palette.xml file referenced by the specified URL.
`void`	`removeAll()` Removes all categories and symbols from the palette.
`void`	`removePaletteListener(PaletteListener l)` Removed a listener that listens to palette events.
`void`	`removeValueSet(IlvPaletteSymbolParameterValueSet vset)` Removes a value set from this palette.
`void`	`replace(IlvPaletteObject oldObject, IlvPaletteObject newObject)` Replaces the old palette object with the new palette object.
`void`	`setDefaultLocale(Locale locale)` Sets the locale used to store name and description.
`void`	`setDescription(Locale locale, String description)` Sets the description of this palette for a given locale.
`void`	`setDescription(String description)` Sets the description of this palette for the default locale.
`void`	`setIconResourceName(String s)` Set the resource access string of the symbol's icon.
`void`	`setIconURL(URL iconurl)` Sets the url to the icon file.
`void`	`setName(Locale locale, String name)` Sets the palette name for a given locale.
`void`	`setName(String name)` Sets the palette name for the default locale.
`void`	`setPackageName(String packageName)` Sets new package name.
`void`	`setRoot(IlvPaletteCategory root)` Sets the root category of the palette.
`IlvPaletteCategory`	`setRootCategory(String categoryID)` Creates a new category and sets it as root of this palette.
`String`	`toString()` Returns the name of the palette

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

- Field Detail
  - PALETTE_DESCRIPTION_FILE
```
public static final String PALETTE_DESCRIPTION_FILE
```
    Constant defining the name of the xml file containing palette's description: "palette.xml"
    
    See Also:
    
    Constant Field Values
  - SMALLICON_SIZE
```
public static final int SMALLICON_SIZE
```
    size of small icon representing the palette
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvPalette
```
public IlvPalette()
```
    Creates a new palette.
  - IlvPalette
```
public IlvPalette(ClassLoader classLoader)
```
    Creates a new palette.
    
    Parameters:
    
    classLoader - The class loader to find the resources of the palette.
- Method Detail
  - load
```
public void load(URL urlOfPaletteXml)
          throws IOException
```
    Loads a palette by reading the content of the palette.xml file referenced by the specified URL. Categories and symbols described in this palette description will be created and their resources retrieved using the resource management system.
    
    Parameters:
    
    urlOfPaletteXml - URL of the palette.xml file
    
    Throws:
    
    IOException
  - setName
```
public void setName(Locale locale,
                    String name)
```
    Sets the palette name for a given locale.
    
    Parameters:
    
    locale - the locale use to store the name
    
    name - the new name of this palette
  - getName
```
public String getName(Locale locale)
```
    Returns the palette name for a given locale.
    
    Parameters:
    
    locale - the locale
    
    Returns:
    
    the palette name
  - setName
```
public void setName(String name)
```
    Sets the palette name for the default locale. You can use setDefaultLocale(java.util.Locale) to change the locale under which the name is stored.
    
    Parameters:
    
    name - the name
    
    See Also:
    
    getDefaultLocale()
  - getName
```
public String getName()
```
    Returns the palette name for the default locale. You can use setDefaultLocale(java.util.Locale) to change the locale under which the name is looked up.
    
    See Also:
    
    getDefaultLocale()
  - setDescription
```
public void setDescription(Locale locale,
                           String description)
```
    Sets the description of this palette for a given locale.
    
    Parameters:
    
    locale - the locale use to store the name
    
    description - the new palette's description
  - getDescription
```
public String getDescription(Locale locale)
```
    Returns the palette description for a given locale.
    
    Parameters:
    
    locale - the locale
    
    Returns:
    
    the description of the palette
  - setDescription
```
public void setDescription(String description)
```
    Sets the description of this palette for the default locale. You can use setDefaultLocale(java.util.Locale) to change the locale under which the description is stored.
    
    Parameters:
    
    description - the new description
    
    See Also:
    
    getDefaultLocale()
  - getDescription
```
public String getDescription()
```
    Returns the palette description for the default locale. You can use setDefaultLocale(java.util.Locale) to change the locale under which the description is looked up.
    
    See Also:
    
    getDefaultLocale()
  - getIconURL
```
public URL getIconURL()
```
    Returns the string representation of the URL to the icon
    
    Returns:
    
    the URL of the icon
  - setIconURL
```
public void setIconURL(URL iconurl)
```
    Sets the url to the icon file. It also updates the resource access string returned by getIconResourceName()
    
    Parameters:
    
    iconurl - url of the icon
  - setIconResourceName
```
public void setIconResourceName(String s)
```
    Set the resource access string of the symbol's icon. It also update the URL to access this resource (see getIconURL() )
    
    Parameters:
    
    s - the new resource access string
  - getIconResourceName
```
public String getIconResourceName()
```
    Returns the resource access string to the symbol icon
  - addCategory
```
public IlvPaletteCategory addCategory(IlvPaletteCategory parent,
                                      String categoryID)
```
    Add a category in the palette. A new category is created and named according specified name. It is added in the given parent category. If the parent category contains already a category or symbol with the same id, the id of the new category is modified so that the ids are unique.
    
    Parameters:
    
    parent - Category in which the new one will be added
    
    categoryID - ID that will be given to the new category
    
    Returns:
    
    the new category
    
    See Also:
    
    IlvPaletteCategory.add(IlvPaletteCategory)
  - addSymbol
```
public IlvPaletteSymbol addSymbol(IlvPaletteCategory parent,
                                  String symbolID)
```
    Add a symbol in the palette. A new symbol is created and named according specified name. It is added in the given parent category. If the parent category contains already a category or symbol with the same id, the id of the new symbol is modified so that the ids are unique.
    
    Parameters:
    
    parent - Category in which the new symbol will be added
    
    symbolID - ID that will be given to the new symbol
    
    Returns:
    
    the new symbol
  - replace
```
public void replace(IlvPaletteObject oldObject,
                    IlvPaletteObject newObject)
```
    Replaces the old palette object with the new palette object. The old palette object gets removed and the new palette object gets added. The palette objects can be either symbols (IlvPaletteSymbol) or palette categories (IlvPaletteCategory). The new palette object will have the same index as the old palette object. Note that by replacing a palette category that contains children, these children will be removed as well.
    
    Parameters:
    
    oldObject - The object to remove.
    
    newObject - The object to add.
  - getSymbol
```
public IlvPaletteSymbol getSymbol(String path)
```
    Returns the first occurrence of a symbol matching the specified path. The path is composed of categories names and ending by symbol's name, separated by "." character (example: "category1.category2.symbol1"). The search always starts from root.
    
    Parameters:
    
    path - the path of the symbol
    
    Returns:
    
    the first occurrence of the symbol matching the path
  - getCategory
```
public IlvPaletteCategory getCategory(String path)
```
    Returns the first occurrence of a category matching the specified path. The path is composed of categories names separated by "." character (example: "category1.category2.category3"). The search always starts from root.
    
    Parameters:
    
    path - the path of the category
    
    Returns:
    
    the first occurrence of the category matching the path
  - getPaletteObject
```
public IlvPaletteObject getPaletteObject(String path)
```
    Returns the first occurrence of a category or symbol matching the specified path. The path is composed of categories names, optionally ending by the symbol's name, separated by "." character (example: "category1.category2.symbol1"). The search always starts from root.
    
    Parameters:
    
    path - the path of the category
    
    Returns:
    
    the first occurrence of the category or symbol matching the path
  - getSymbol
```
public IlvPaletteSymbol getSymbol(String cssResourceName,
                                  String className)
```
    Returns the first occurrence of a symbol that has the specified CSS resource name and the specified class name.
    
    Parameters:
    
    cssResourceName - The CSS resource name.
    
    className - The class name.
    
    Returns:
    
    The symbol that matches the CSS resource name and the class name.
    
    See Also:
    
    IlvPaletteSymbol.getCSSResourceName(), IlvPaletteSymbol.getClassName()
  - removeAll
```
public void removeAll()
```
    Removes all categories and symbols from the palette.
  - toString
```
public String toString()
```
    Returns the name of the palette
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String the palette description
  - getIcon
```
public Icon getIcon()
```
    Gets the icon associated to the palette
    
    Returns:
    
    Icon
  - getSmallIcon
```
public ImageIcon getSmallIcon()
```
    Gets the small size icon representing the palette
    
    Returns:
    
    The icon
  - getRoot
```
public IlvPaletteCategory getRoot()
```
    Returns the root category of this palette
  - setRoot
```
public void setRoot(IlvPaletteCategory root)
```
    Sets the root category of the palette. The input category must not belong to any other palette, and must not be a subcategory of another category.
    If the old root is not null a palette event for the old root is fired through the categoryRemoved method of PaletteListener. If the new root is not null a palette event for the new root is fired through the categoryAdded method of PaletteListener.
    
    Parameters:
    
    root - The new root category.
    
    See Also:
    
    PaletteEvent, PaletteListener
  - setRootCategory
```
public IlvPaletteCategory setRootCategory(String categoryID)
```
    Creates a new category and sets it as root of this palette.
    
    Parameters:
    
    categoryID - The id of the root category.
    
    Returns:
    
    The newly created root category.
    
    See Also:
    
    setRoot(ilog.views.symbology.palettes.IlvPaletteCategory)
  - getChildren
```
public Enumeration getChildren(Object parent)
```
    Returns and enumeration of the children of the specified parent. If the parent is not a category, it returns null
    
    Parameters:
    
    parent - The parent category
    
    Returns:
    
    Enumeration The enumeration of children
  - getParent
```
public Object getParent(Object object)
```
    Returns the parent of the specified object. If this object is neither a symbol (IlvPaletteSymbol) nor a category (IlvPaletteCategory) it returns null.
    
    Parameters:
    
    object - The object
    
    Returns:
    
    Object The parent
  - getChildCount
```
public int getChildCount(Object parent)
```
    Returns the number of children in the specified parent
    
    Parameters:
    
    parent - The parent, an instance of IlvPaletteCategory
  - isCategory
```
public boolean isCategory(Object object)
```
    Indicates if the specified object is an instance of IlvPaletteCategory
  - addPaletteListener
```
public void addPaletteListener(PaletteListener l)
```
    Adds a listener that listens to palette events.
  - removePaletteListener
```
public void removePaletteListener(PaletteListener l)
```
    Removed a listener that listens to palette events.
  - fireCategoryAdded
```
protected void fireCategoryAdded(IlvPaletteCategory parent,
                                 IlvPaletteCategory category)
```
    Fire an event when adding category to the category hierarchy.
    
    Parameters:
    
    parent - the new parent category
    
    category - the category added
    
    See Also:
    
    PaletteListener, PaletteEvent
  - fireCategoryRemoved
```
protected void fireCategoryRemoved(IlvPaletteCategory parent,
                                   IlvPaletteCategory category)
```
    Fire an event when removing a category from the category hierarchy.
    
    Parameters:
    
    parent - the old parent category
    
    category - the category removed
    
    See Also:
    
    PaletteListener, PaletteEvent
  - fireSymbolAdded
```
protected void fireSymbolAdded(IlvPaletteCategory parent,
                               IlvPaletteSymbol symbol)
```
    Fire an event when adding a symbol into a category.
    
    Parameters:
    
    parent - the new parent category of the symbol
    
    symbol - the symbol added
    
    See Also:
    
    PaletteListener, PaletteEvent
  - fireSymbolRemoved
```
protected void fireSymbolRemoved(IlvPaletteCategory parent,
                                 IlvPaletteSymbol symbol)
```
    Fire an event when removing a symbol from a category.
    
    Parameters:
    
    parent - the old parent category of the symbol
    
    symbol - the symbol removed
    
    See Also:
    
    PaletteListener, PaletteEvent
  - getJarURL
```
public URL getJarURL()
```
    Returns the URL to the palette jar file.
  - getPackageName
```
public String getPackageName()
```
    Returns the package name in which the palette.xml file is located.
  - setPackageName
```
public void setPackageName(String packageName)
```
    Sets new package name. It must be something like dir1/dir2/.../dirN/
    
    Parameters:
    
    packageName - The new name of the package
  - getPaletteResourceName
```
public String getPaletteResourceName()
```
    Returns the resource access name to palette.xml. Something like a/a1/a2/palette.xml
  - getPaletteURL
```
public URL getPaletteURL()
```
    Returns URL to access palette.xml
  - setDefaultLocale
```
public void setDefaultLocale(Locale locale)
```
    Sets the locale used to store name and description. Pass null for the locale of the default resource bundle.
    
    See Also:
    
    setName(String), getName(), setDescription(String), getDescription()
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Returns the locale used to store name and description. Returns null for the locale of the default resource bundle.
    
    See Also:
    
    setName(String), getName(), setDescription(String), getDescription()
  - addValueSet
```
public String addValueSet(IlvPaletteSymbolParameterValueSet vset,
                          boolean checkDuplicates)
```
    Adds a value set to this palette. A value set represents a set of distinct values allowed for a symbol parameter (like an enum type). A value set can be used in a symbol parameter after it has been added to the palette. Different symbol parameters can share the same value set instance.
    If the flag checkDuplicates is true and a value set representing the same values is already contained in this palette, the ID of this value set is returned and the input value set is not added. In this case, the typical code to add a value set and to work with the added value set is this:
```
 valueSet = palette.getValueSet(palette.addValueSet(valueSet, true));
 
```
    If a different value set with the same ID is already contained in this palette, the ID of the input value set is modified to be unique, and the input value set is added. The modified ID is returned.
    Parameters:
    
    vset - The value set
    
    checkDuplicates - Whether duplicates are checked
    
    Returns:
    
    The id of the added value set
    
    See Also:
    
    removeValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet)
  - removeValueSet
```
public void removeValueSet(IlvPaletteSymbolParameterValueSet vset)
```
    Removes a value set from this palette. A value set represents a set of distinct values allowed for a symbol parameter (like an enum type). A value set can be used in a symbol parameter after it has been added to the palette. Different symbol parameters can share the same value set instance.
    
    Parameters:
    
    vset - The value set
    
    See Also:
    
    addValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet, boolean)
  - getValueSetCount
```
public int getValueSetCount()
```
    Returns the number of value sets of this palette.
    
    See Also:
    
    addValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet, boolean)
  - getValueSet
```
public IlvPaletteSymbolParameterValueSet getValueSet(int index)
```
    Returns the value set with the given index.
    
    See Also:
    
    addValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet, boolean)
  - getValueSet
```
public IlvPaletteSymbolParameterValueSet getValueSet(String id)
```
    Returns the value set with the given ID.
    
    See Also:
    
    addValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet, boolean)
  - getValueSets
```
public IlvPaletteSymbolParameterValueSet[] getValueSets()
```
    Returns all value sets added to this palette.
    
    See Also:
    
    addValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet, boolean)
  - fireValueSetAdded
```
protected void fireValueSetAdded(IlvPaletteSymbolParameterValueSet vset)
```
    Fire an event when adding a value set to the palette.
    
    Parameters:
    
    vset - the value set added
    
    See Also:
    
    addValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet, boolean), PaletteListener, PaletteEvent
  - fireValueSetRemoved
```
protected void fireValueSetRemoved(IlvPaletteSymbolParameterValueSet vset)
```
    Fire an event when removing a value set from the palette.
    
    Parameters:
    
    vset - the value set removed
    
    See Also:
    
    removeValueSet(ilog.views.symbology.palettes.IlvPaletteSymbolParameterValueSet), PaletteListener, PaletteEvent

Class IlvPalette

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PALETTE_DESCRIPTION_FILE

SMALLICON_SIZE

Constructor Detail

IlvPalette

IlvPalette

Method Detail

load

setName

getName

setName

getName

setDescription

getDescription

setDescription

getDescription

getIconURL

setIconURL

setIconResourceName

getIconResourceName

addCategory

addSymbol

replace

getSymbol

getCategory

getPaletteObject

getSymbol

removeAll

toString

getIcon

getSmallIcon

getRoot

setRoot

setRootCategory

getChildren

getParent

getChildCount

isCategory

addPaletteListener

removePaletteListener

fireCategoryAdded

fireCategoryRemoved

fireSymbolAdded

fireSymbolRemoved

getJarURL

getPackageName

setPackageName

getPaletteResourceName

getPaletteURL

setDefaultLocale

getDefaultLocale

addValueSet

removeValueSet

getValueSetCount

getValueSet

getValueSet

getValueSets

fireValueSetAdded

fireValueSetRemoved