Package ilog.views.symbology.palettes

Contains the support for palettes of symbols.

See: Description

Interface Summary

Interface	Description
IlvPaletteObject	A common interface for objects that could be added into a palette.

Class Summary

Class	Description
IlvPalette	A palette is a collection of symbols that could be grouped into a hierarchy of categories.
IlvPaletteBaseObject	This class is the base class of palette symbols, palette categories and palette parameters.
IlvPaletteCategory	IlvPaletteCategory allows to organize the content of a palette in a hierarchy of logical groups.
IlvPaletteCategoryChild	This class is the base class for objects that can be contained in a palette category.
IlvPaletteDocumentation	Creates the documentation for a palette or for a set of symbols.
IlvPaletteManager	This object manage a set of palettes.
IlvPaletteSymbol	Palette symbols are objects containing description data of symbols that can be added in a dashboard or a map, for example.
IlvPaletteSymbolParameter	This class allows user to create an additional parameter that will be added to a symbol.
IlvPaletteSymbolParameterValueSet	This class represents a set of distinct values allowed for a symbol parameter.

Package ilog.views.symbology.palettes Description

Contains the support for palettes of symbols. As palette, we consider here the logical grouping of multiple symbol definitions in one jar file, not the GUI component that displays the palette. A symbol of a palette is essentially a CSS specification of a composite graphic. The symbol specification hides the internals of the symbol from the outside world by a definition of a set of formal parameters of the symbol. See ilog.views.symbology for more explanations.

Here an overview of the classes:

• A palette manager (IlvPaletteManager) contains a set of palettes. The palette manager allows loading and saving palettes dynamically through the file system. The palette manager must be attached to a diagrammer, to that the diagrammer knows which palettes are currently loaded.
• A palette (IlvPalette) is a collection of symbol definitions that can be organized in categories. A palette has a root category. Usually, a palette is saved in a jar file under a package path such as "myapplication/mypackage/mypalette1".
• A palette category (IlvPaletteCategory) is an organizational unit of symbols in the palette. A palette contains a tree of categories, i.e., each category can contain subcategories and symbols (IlvPaletteSymbol).
• A palette symbol (IlvPaletteSymbol) is essentially the definition of a symbol. It contains all necessary information to allow CSS to create instances of the symbol in the diagrammer. The palette symbol contains the CSS of the symbol, the class name which acts as entry point in the CSS, and the definition of the symbol parameters.
• An instance of IlvPaletteSymbolParameter contains the definition of one formal parameter of a symbol.
• Sometimes, symbol parameters allow only a limited set of values, such as "wait", "attention", "go", or 1, 2, 3. This is similar to an enum type. The class IlvPaletteSymbolParameterValueSet contains the description of a value set.

On the file system, palettes are organized in jar files. If the set of palettes used by your application is fixed, the palette jar files can be simply put in the class path of your application. In this case, no palette manager is needed. The palette manager is only needed in applications that must load and save palettes dynamically, i.e., if the set of palettes used by the application is not known in advance.

See Also:

ilog.views.symbology