ilog.views.symbology.palettes

Class IlvPaletteCategory

java.lang.Object

ilog.views.symbology.palettes.IlvPaletteBaseObject

ilog.views.symbology.palettes.IlvPaletteCategoryChild

ilog.views.symbology.palettes.IlvPaletteCategory

All Implemented Interfaces:

IlvPaletteObject, Serializable

public class IlvPaletteCategory
extends IlvPaletteCategoryChild
implements IlvPaletteObject

IlvPaletteCategory allows to organize the content of a palette in a hierarchy of logical groups.

Since:

JViews 8.0

See Also:

IlvPalette, IlvPaletteSymbol, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvPaletteCategory(String id) Creates a new category and sets its ID.

Method Summary

Modifier and Type	Method and Description
void	add(IlvPaletteCategory category) Adds a category into this category.
void	add(IlvPaletteObject object) Adds an object into the category.
void	add(IlvPaletteSymbol symbol) Adds a symbol into the category.
void	add(int index, IlvPaletteCategory category) Adds a category into this category at the specified position.
void	add(int index, IlvPaletteObject object) Adds an object into the category at the specified position.
void	add(int index, IlvPaletteSymbol symbol) Adds a symbol into the category at the specified position.
IlvPaletteObject	copy() Makes a deep copy of this category, meaning that it also copies the objects (symbol or categories) contained into this category.
protected IlvPaletteBaseObject	copy(IlvPaletteBaseObject owner) Makes a copy of this object.
protected IlvPaletteBaseObject	createNew() Allocates a new object of the same type.
IlvPaletteObject	getChild(int index) Returns the child located at specified index in the category.
Enumeration	getChildren() Returns the nodes contained in the category.
int	getChildrenCount() Returns the number children contained in the category.
int	indexOf(Object child) Returns the position of the child in the category
void	remove(IlvPaletteCategory category) Removes a given category from the category.
void	remove(IlvPaletteObject object) Removes an object from the category.
void	remove(IlvPaletteSymbol symbol) Removes a symbol from this category.
void	replace(IlvPaletteObject oldObject, IlvPaletteObject newObject) Replaces the old palette object with the new palette object.

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

getPalette, getParent, toString

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

getBaseObjectOwner, getDefaultLocale, getFullID, getID, getLongDescription, getLongDescription, getName, getName, getOwner, getShortDescription, getShortDescription, setDefaultLocale, setID, setLongDescription, setLongDescription, setName, setName, setOwner, setShortDescription, setShortDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.views.symbology.palettes.IlvPaletteObject

getID, getPalette, getParent

Constructor Detail

IlvPaletteCategory

public IlvPaletteCategory(String id)

Creates a new category and sets its ID.

Parameters:

id - The ID of the palette.

Method Detail

add

public void add(IlvPaletteObject object)

Adds an object into the category. It can be either a symbol (IlvPaletteSymbol) or a category.

Parameters:

object - The node to add.

add

public void add(int index,
                IlvPaletteObject object)

Adds an object into the category at the specified position. It can be either a symbol (IlvPaletteSymbol) or a category.

Parameters:

index - The position

object - The node to add.

Since:

JViews 8.1

add

public void add(IlvPaletteSymbol symbol)

Adds a symbol into the category. A palette event is fired through the symbolAdded method of PaletteListener.

Parameters:

symbol - The symbol to add.

See Also:

PaletteEvent, PaletteListener

add

public void add(IlvPaletteCategory category)

Adds a category into this category. A palette event is fired through the categoryAdded method of PaletteListener.

Parameters:

category - The category to add.

See Also:

PaletteEvent, PaletteListener

add

public void add(int index,
                IlvPaletteSymbol symbol)

Adds a symbol into the category at the specified position. A palette event is fired through the symbolAdded method of PaletteListener.

Parameters:

index - The position in the category.

symbol - The symbol to add.

Since:

JViews 8.1

See Also:

PaletteEvent, PaletteListener

add

public void add(int index,
                IlvPaletteCategory category)

Adds a category into this category at the specified position. A palette event is fired through the categoryAdded method of PaletteListener.

Parameters:

index - The position in the category.

category - The category to add.

Since:

JViews 8.1

See Also:

PaletteEvent, PaletteListener

remove

public void remove(IlvPaletteObject object)

Removes an object from the category.

Parameters:

object - The node to remove.

remove

public void remove(IlvPaletteSymbol symbol)

Removes a symbol from this category. A palette event is fired through the symbolRemoved method of PaletteListener.

Parameters:

symbol - The symbol to remove.

See Also:

PaletteEvent, PaletteListener

remove

public void remove(IlvPaletteCategory category)

Removes a given category from the category. A palette event is fired through the categoryRemoved method of PaletteListener.

Parameters:

category - The category to remove.

See Also:

PaletteEvent, PaletteListener

replace

public void replace(IlvPaletteObject oldObject,
                    IlvPaletteObject newObject)

Replaces the old palette object with the new palette object. The old palette object gets removed from this category and the new palette object gets added to this category. 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.

getChildren

public Enumeration getChildren()

Returns the nodes contained in the category.

Returns:

An enumeration of IlvPaletteCategory and IlvPaletteSymbol

getChildrenCount

public int getChildrenCount()

Returns the number children contained in the category.

getChild

public IlvPaletteObject getChild(int index)

Returns the child located at specified index in the category.

Parameters:

index - index of the child

Returns:

The child, either IlvPaletteCategory or IlvPaletteSymbol

copy

public IlvPaletteObject copy()

Makes a deep copy of this category, meaning that it also copies the objects (symbol or categories) contained into this category.

Specified by:

copy in interface IlvPaletteObject

Overrides:

copy in class IlvPaletteCategoryChild

Returns:

IlvPaletteObject 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 IlvPaletteCategoryChild

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

indexOf

public int indexOf(Object child)

Returns the position of the child in the category

Parameters:

child - the object for which to search.

Returns:

int The index in the list

Since:

JViews 8.1