oracle.ide.palette2

Class PalettePage

java.lang.Object

oracle.ide.palette2.PalettePage

Direct Known Subclasses:

DefaultPalettePage

public abstract class PalettePage
extends java.lang.Object

Palette Page is an abstract class and is the first level of the Component Palette model and a "child" of PalettePages.

PalettePage is the major application category grouping within the Palette. Users know PalettePage as a selection within the dropdown list at the top of the Component Palette UI. A PalettePage may have zero or more PaletteGroups.

See Also:

PalettePages, PaletteGroup

Constructor Summary

Constructors

Constructor and Description
PalettePage()

Method Summary

Modifier and Type	Method and Description
void	dispose()
boolean	equals(java.lang.Object object)
abstract java.lang.Object	getData(java.lang.Object key) Get data
abstract java.lang.String	getDescription() Get description.
abstract java.util.Collection<PaletteGroup>	getGroups() Get all Palette Groups
abstract javax.swing.Icon	getIcon() Get Icon.
abstract java.lang.String	getName() Get display name.
java.lang.String	getPageKey() Generate a unique key for this palette page.
int	hashCode()
boolean	isEmpty()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PalettePage

public PalettePage()

Method Detail

getGroups

public abstract java.util.Collection<PaletteGroup> getGroups()

Get all Palette Groups

Returns:

unmodifiable collection of paletteGroup's

getName

public abstract java.lang.String getName()

Get display name.

Returns:

display name.

getDescription

public abstract java.lang.String getDescription()

Get description.

Returns:

string.

getIcon

public abstract javax.swing.Icon getIcon()

Get Icon.

Returns:

icon.

getData

public abstract java.lang.Object getData(java.lang.Object key)

Get data

Use to surface arbitrary additional data. This is used to identify the item to their clients without requiring clients to cast to a PaletteItem subclass.

For example, in XMLEF, use getData to get from a PaletteItem back to the identification of what type of element to create (XmlKey). XMLEF's PaletteItem instances will have this data.

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

dispose

public void dispose()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPageKey

public java.lang.String getPageKey()

Generate a unique key for this palette page. The key should not necessarily reflect uniqueness of the instance, but rather the unique collection of groups, section and items within the page.

Returns: