oracle.ide.palette2

Class DefaultPaletteGroup

java.lang.Object

oracle.ide.palette2.PaletteGroup

oracle.ide.palette2.DefaultPaletteGroup

public class DefaultPaletteGroup
extends PaletteGroup

DefaultPaletteGroup - class provides a default PaletteGroup 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, DefaultPaletteSection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPaletteGroup.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GROUP_GROUPEDITOR
static java.lang.String	GROUP_GROUPID HashMap pageData keys
static java.lang.String	GROUP_LAYOUT
static java.lang.String	GROUP_PROJECTCONFIGURATION
static java.lang.String	GROUP_SHOWFORTYPES
static java.lang.String	GROUP_TECHNOLOGYSCOPES
static java.lang.String	GROUP_TYPE

Fields inherited from class oracle.ide.palette2.PaletteGroup

DEFAULT_LAYOUT, ICON_LAYOUT, ICON_LAYOUT_WITH_BOTTOM_LABELS, LIST_LAYOUT

Constructor Summary

Constructors

Constructor and Description
DefaultPaletteGroup() Default Constructor.
DefaultPaletteGroup(java.lang.String name, java.lang.String description, java.lang.String groupId, java.lang.String type) Deprecated. Use the public static inner Builder class to construct a new instance.
DefaultPaletteGroup(java.lang.String name, java.lang.String description, java.lang.String icon, java.lang.String groupId, java.lang.String groupEditor, java.lang.String projectConfiguration, java.util.List<java.lang.String> showForTypes, java.util.List<java.lang.String> technologyScopes, java.lang.String type) Deprecated. Use the public static inner Builder class to construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	addSection(PaletteSection section) Add Palette Section
boolean	equals(java.lang.Object obj)
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.
java.lang.String	getDescription() Get description.
javax.swing.Icon	getIcon() Get Icon.
PaletteItem	getItem(java.lang.String itemId)
java.lang.String	getLayout() Get the string representing the layout ID to be used for this group.
java.lang.String	getName() Get display name.
java.util.Collection<PaletteSection>	getSections() Get Palette Sections
boolean	isVisible(Context context) Indicates whether or not a palette group should be visible based on the supplied context.
protected void	removeAllSections() Remove All Palette Items
protected void	removeSection(PaletteSection section) Remove Palette Section
protected void	setData(java.lang.Object key, java.lang.Object data)
protected void	setDescription(java.lang.String description)
protected void	setIcon(javax.swing.Icon icon)
protected void	setIcon(java.lang.String iconParm)
protected void	setName(java.lang.String name)
java.lang.String	toString()

Methods inherited from class oracle.ide.palette2.PaletteGroup

dispose, hashCode, isEmpty

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_GROUPID

public static final java.lang.String GROUP_GROUPID

HashMap pageData keys

See Also:

Constant Field Values

GROUP_GROUPEDITOR

public static final java.lang.String GROUP_GROUPEDITOR

See Also:

Constant Field Values

GROUP_PROJECTCONFIGURATION

public static final java.lang.String GROUP_PROJECTCONFIGURATION

See Also:

Constant Field Values

GROUP_SHOWFORTYPES

public static final java.lang.String GROUP_SHOWFORTYPES

See Also:

Constant Field Values

GROUP_TECHNOLOGYSCOPES

public static final java.lang.String GROUP_TECHNOLOGYSCOPES

See Also:

Constant Field Values

GROUP_TYPE

public static final java.lang.String GROUP_TYPE

See Also:

Constant Field Values

GROUP_LAYOUT

public static final java.lang.String GROUP_LAYOUT

See Also:

Constant Field Values

Constructor Detail

DefaultPaletteGroup

public DefaultPaletteGroup()

Default Constructor.

DefaultPaletteGroup

@Deprecated
public DefaultPaletteGroup(java.lang.String name,
                                       java.lang.String description,
                                       java.lang.String groupId,
                                       java.lang.String type)

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

DefaultPaletteGroup

@Deprecated
public DefaultPaletteGroup(java.lang.String name,
                                       java.lang.String description,
                                       java.lang.String icon,
                                       java.lang.String groupId,
                                       java.lang.String groupEditor,
                                       java.lang.String projectConfiguration,
                                       java.util.List<java.lang.String> showForTypes,
                                       java.util.List<java.lang.String> technologyScopes,
                                       java.lang.String type)

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

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 PaletteGroup

setData

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

getItem

public PaletteItem getItem(java.lang.String itemId)

addSection

public void addSection(PaletteSection section)

Add Palette Section

Parameters:

section -

removeSection

protected void removeSection(PaletteSection section)

Remove Palette Section

Parameters:

section -

removeAllSections

protected void removeAllSections()

Remove All Palette Items

getName

public java.lang.String getName()

Description copied from class: PaletteGroup

Get display name.

Specified by:

getName in class PaletteGroup

Returns:

display name.

setName

protected void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

Description copied from class: PaletteGroup

Get description.

Specified by:

getDescription in class PaletteGroup

Returns:

string.

setDescription

protected void setDescription(java.lang.String description)

getIcon

public javax.swing.Icon getIcon()

Description copied from class: PaletteGroup

Get Icon.

Specified by:

getIcon in class PaletteGroup

Returns:

Icon.

setIcon

protected void setIcon(java.lang.String iconParm)

setIcon

protected void setIcon(javax.swing.Icon icon)

getSections

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

Get Palette Sections

Specified by:

getSections in class PaletteGroup

Returns:

unmodifiable collection of paletteSection's

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class PaletteGroup

toString

public java.lang.String toString()

Overrides:

toString in class PaletteGroup

isVisible

public boolean isVisible(Context context)

Description copied from class: PaletteGroup

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

Specified by:

isVisible in class PaletteGroup

Parameters:

context - The active context

Returns:

true if the group should be visible

getLayout

public java.lang.String getLayout()

Description copied from class: PaletteGroup

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.

Overrides:

getLayout in class PaletteGroup

Returns:

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

getDefaultLayout

public java.lang.String getDefaultLayout()

Description copied from class: PaletteGroup

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.

Overrides:

getDefaultLayout in class PaletteGroup

Returns:

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