oracle.ide.palette2

Class PaletteGroup

java.lang.Object

oracle.ide.palette2.PaletteGroup

Direct Known Subclasses:

DefaultPaletteGroup

public abstract class PaletteGroup
extends java.lang.Object

Palette Group is the second level the Component Palette model and is the "child" of PalettePage. A Palette Group is a subcategory grouping within a PalettePage. Users know Palette Groups as the accordian windows displayed within the Component Palette UI. Palette Group consists of zero or more Palette Sections.

See Also:

Palette, PalettePage, PaletteSection, PaletteItem

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LAYOUT
static java.lang.String	ICON_LAYOUT
static java.lang.String	ICON_LAYOUT_WITH_BOTTOM_LABELS
static java.lang.String	LIST_LAYOUT

Constructor Summary

Constructors

Constructor and Description
PaletteGroup()

Method Summary

Methods

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
java.lang.String	getDefaultLayout() Get the string representing the default layout ID to be used for this group.
abstract java.lang.String	getDescription() Get description.
abstract javax.swing.Icon	getIcon() Get Icon.
java.lang.String	getLayout() Get the string representing the layout ID to be used for this group.
abstract java.lang.String	getName() Get display name.
abstract java.util.Collection<PaletteSection>	getSections() Get Palette Sections
int	hashCode()
boolean	isEmpty()
abstract boolean	isVisible(Context context) Indicates whether or not a palette group should be visible based on the supplied context.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LIST_LAYOUT

public static final java.lang.String LIST_LAYOUT

See Also:

Constant Field Values

ICON_LAYOUT

public static final java.lang.String ICON_LAYOUT

See Also:

Constant Field Values

ICON_LAYOUT_WITH_BOTTOM_LABELS

public static final java.lang.String ICON_LAYOUT_WITH_BOTTOM_LABELS

See Also:

Constant Field Values

DEFAULT_LAYOUT

public static final java.lang.String DEFAULT_LAYOUT

See Also:

Constant Field Values

Constructor Detail

PaletteGroup

public PaletteGroup()

Method Detail

getSections

public abstract java.util.Collection<PaletteSection> getSections()

Get Palette Sections

Returns:

unmodifiable collection of PaletteSection'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.

isVisible

public abstract boolean isVisible(Context context)

Indicates whether or not a palette group should be visible based on the supplied context.

Parameters:

context - The active context

Returns:

true if the group should be visible

getLayout

public java.lang.String getLayout()

Get the string representing the layout ID to be used for this group. The returned value should be used in conjunction with the PaletteLayoutDescriptor.Manager to get the descriptor for the value.

Returns:

the string representing the layout ID to be used for this group

getDefaultLayout

public java.lang.String getDefaultLayout()

Get the string representing the default layout ID to be used for this group. The returned value should be used in conjunction with the PaletteLayoutDescriptor.Manager to get the descriptor for the value.

Returns:

the string representing the default layout ID to be used for this group

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