Skip navigation links

oracle.ide.palette2
Class PaletteItem

java.lang.Object
oracle.ide.palette2.PaletteItem

Direct Known Subclasses:

DefaultPaletteItem

public abstract class PaletteItem

extends java.lang.Object

Palette Item is the leaf of the Component Palette model and is the "child" of PaletteSection. PaletteItem describes a component that is displayed within the Component Palette.

See Also:

PaletteSection

Field Summary

static java.awt.datatransfer.DataFlavor

PALETTE_ITEM_FLAVOR Drag and Drop DataFlavor representing a PaletteItem.

Constructor Summary

PaletteItem()

Method Summary

abstract java.lang.Object	getData(java.lang.Object key) Get data
abstract java.lang.String	getDescription() Get description.
abstract java.lang.String	getHelpable() Get help link.
abstract javax.swing.Icon	getIcon() Get Icon.
abstract java.lang.String	getItemId() Get Item Id.
abstract java.lang.String	getName() Get display name.
abstract java.lang.String	getProviderId() Get Provider Id.
abstract java.lang.String	getSearchTextContext() Get search text context callback name.

Methods inherited from class java.lang.Object

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

Field Detail

PALETTE_ITEM_FLAVOR

public static final java.awt.datatransfer.DataFlavor PALETTE_ITEM_FLAVOR

Drag and Drop DataFlavor representing a PaletteItem.

Constructor Detail

PaletteItem

public PaletteItem()

Method Detail

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.

getItemId

public abstract java.lang.String getItemId()

Get Item Id.

Unique identifier for item within Palette.

Returns:

string.

getProviderId

public abstract java.lang.String getProviderId()

Get Provider Id.

An identifier that is utilized to identify this item as belonging to the page provider that 'owns' this item. For example, oracle.ide.palette2.DeclaredPageProvider may own all statically declared items.

Returns:

string.

getSearchTextContext

public abstract java.lang.String getSearchTextContext()

Get search text context callback name.

Returns:

searchTextContext

getHelpable

public abstract java.lang.String getHelpable()

Get help link.

Returns:

helpable

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.

Skip navigation links