ilog.views.symbology.palettes.event

Class PaletteEvent

java.lang.Object

java.util.EventObject

ilog.views.symbology.palettes.event.PaletteEvent

All Implemented Interfaces:

Serializable

public class PaletteEvent
extends EventObject

This event is sent to PaletteListener when changes occur in the palette.

Since:

JViews 8.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	added The added flag.
protected IlvPaletteBaseObject	child The child.
protected IlvPaletteCategory	parent The parent.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PaletteEvent(IlvPalette source, IlvPaletteCategory parent, IlvPaletteCategoryChild child, boolean added) Creates an event
PaletteEvent(IlvPalette source, IlvPaletteSymbolParameterValueSet vset, boolean added) Creates an event

Method Summary

Modifier and Type	Method and Description
IlvPaletteCategoryChild	getChild() Returns the child (a category or symbol) that has been added or removed.
IlvPalette	getPalette() Returns the palette that has caused the event.
IlvPaletteCategory	getParentCategory() Returns the parent category the child has been added to or removed from.
IlvPaletteSymbolParameterValueSet	getValueSet() Returns the value set that has been added or removed.
boolean	isAdded() Returns whether the child was added to the parent category or removed from the parent category.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected transient IlvPaletteCategory parent

The parent.

See Also:

getParentCategory()

child

protected transient IlvPaletteBaseObject child

The child.

See Also:

getChild()

added

protected transient boolean added

The added flag.

See Also:

isAdded()

Constructor Detail

PaletteEvent

public PaletteEvent(IlvPalette source,
                    IlvPaletteCategory parent,
                    IlvPaletteCategoryChild child,
                    boolean added)

Creates an event

Parameters:

source - The source of the event.

parent - The old or new parent category.

child - The child whose parent has changed.

added - Whether the child was added or removed from parent.

PaletteEvent

public PaletteEvent(IlvPalette source,
                    IlvPaletteSymbolParameterValueSet vset,
                    boolean added)

Creates an event

Parameters:

source - The source of the event.

vset - The palette value set that was added or removed.

added - Whether the value set was added or removed from parent.

Method Detail

getPalette

public IlvPalette getPalette()

Returns the palette that has caused the event.

getValueSet

public IlvPaletteSymbolParameterValueSet getValueSet()

Returns the value set that has been added or removed.

See Also:

isAdded()

getChild

public IlvPaletteCategoryChild getChild()

Returns the child (a category or symbol) that has been added or removed. The parent in which the event happened can be get by using getParentCategory()

See Also:

getParentCategory(), isAdded()

getParentCategory

public IlvPaletteCategory getParentCategory()

Returns the parent category the child has been added to or removed from.

• If the child is a palette category that has been set as root of the palette, the added flag is true and this method returns null.
• If the child is a palette category that has been removed as root of the palette, the added flag is false and this method returns null.
• If the child is a palette category or symbol that has been added to another parent palette category, this method returns the new parent category.
• If the child is a palette category or symbol that has been removed from its parent palette category, this method returns the old parent category.
• If a value set has been added or removed, this method returns null.

See Also:

getChild(), isAdded()

isAdded

public boolean isAdded()

Returns whether the child was added to the parent category or removed from the parent category.

• If the child is a palette category that has been set as root of the palette, the parent category is null and this method returns true.
• If the child is a palette category that has been removed as root of the palette, the parent category is null and this method returns false.
• If the child is a palette category or symbol that has been added to another parent palette category, this method returns true.
• If the child is a palette category or symbol that has been removed from its parent palette category, this method returns false.
• If a value set has been added, this method returns true.
• If a value set has been removed, this method returns false.

See Also:

getValueSet(), getChild(), getParentCategory()