Skip navigation links

oracle.ide.palette2
Class DefaultPaletteSection

java.lang.Object
oracle.ide.palette2.PaletteSection
oracle.ide.palette2.DefaultPaletteSection

public class DefaultPaletteSection

extends PaletteSection

DefaultPaletteSection - class provides a default PaletteSection model implementation that can be extended by client extension developers. Page provider oracle.ideimpl.palete2.DeclaredPageProvider utilizes the DefaultPalette* classes as concrete implementations for static Pages defined in the extension manifest.

See Also:

Palette, DefaultPalettePage, DefaultPaletteGroup, DefaultPaletteItem

Nested Class Summary

static class

DefaultPaletteSection.Builder

Field Summary

static java.lang.String

SECTION_SECTIONID HashMap pageData keys

Constructor Summary

DefaultPaletteSection()
Deprecated. Use the public static inner Builder class to construct a new instance.

DefaultPaletteSection(java.lang.String name, java.lang.String sectionId)
Deprecated. Use the public static inner Builder class to construct a new instance.

Method Summary

void	addItem(PaletteItem item) Add Palette Item
boolean	equals(java.lang.Object obj) Equals
java.lang.Object	getData(java.lang.Object key) Get data
PaletteItem	getItem(java.lang.String itemId)
java.util.Collection<PaletteItem>	getItems() Get Palette Items Items are ordered by Weight followed by name.
java.lang.String	getName() Get display name.
java.util.List<PaletteItem>	getPaletteItems() Get Palette Items Returns unsorted list; as opposed to getItems.
protected void	removeAllItems() Remove All Palette Items
void	removeItem(PaletteItem item) Remove Palette Item
protected void	setData(java.lang.Object key, java.lang.Object data)
protected void	setName(java.lang.String name) Set display name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SECTION_SECTIONID

public static final java.lang.String SECTION_SECTIONID

HashMap pageData keys

See Also:

Constant Field Values

Constructor Detail

DefaultPaletteSection

@Deprecated
public DefaultPaletteSection()

Deprecated. Use the public static inner Builder class to construct a new instance.

Default constructor.

DefaultPaletteSection

@Deprecated
public DefaultPaletteSection(java.lang.String name,
                                        java.lang.String sectionId)

Deprecated. Use the public static inner Builder class to construct a new instance.

Constructor

Method Detail

getData

public 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.

Specified by:

getData in class PaletteSection

setData

protected void setData(java.lang.Object key,
                       java.lang.Object data)

getItem

public PaletteItem getItem(java.lang.String itemId)

addItem

public void addItem(PaletteItem item)

Add Palette Item

Parameters:

item -

removeItem

public void removeItem(PaletteItem item)

Remove Palette Item

Parameters:

item -

removeAllItems

protected void removeAllItems()

Remove All Palette Items

getItems

public java.util.Collection<PaletteItem> getItems()

Get Palette Items Items are ordered by Weight followed by name.

Specified by:

getItems in class PaletteSection

Returns:

unmodifiable collection of paletteItem's

getPaletteItems

public java.util.List<PaletteItem> getPaletteItems()

Get Palette Items Returns unsorted list; as opposed to getItems.

Returns:

unmodifiable collection of paletteItem's

getName

public java.lang.String getName()

Get display name.

See attribute shortLabel.

Specified by:

getName in class PaletteSection

Returns:

display name.

setName

protected void setName(java.lang.String name)

Set display name.

See attribute shortLabel.

equals

public boolean equals(java.lang.Object obj)

Equals

Overrides:

equals in class java.lang.Object

Parameters:

obj -

Returns:

boolean

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Skip navigation links