oracle.ide.palette2

Class DefaultPalettePage

java.lang.Object

oracle.ide.palette2.PalettePage

oracle.ide.palette2.DefaultPalettePage

public class DefaultPalettePage
extends PalettePage

DefaultPalettePage - class provides a default PalettePage 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, DefaultPaletteGroup, DefaultPaletteSection, DefaultPaletteItem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPalettePage.Builder
static class	DefaultPalettePage.PageRecord Holds parameters passed during the creation a page.
static class	DefaultPalettePage.ShowForTypeRecord Holds information about what document types are associated with this page.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ICON
static java.lang.String	PAGE_PAGECONTEXT
static java.lang.String	PAGE_PAGEEDITOR
static java.lang.String	PAGE_PAGEID HashMap pageData keys
static java.lang.String	PAGE_PROJECTCONFIGURATION
static java.lang.String	PAGE_SHOWFORTYPES
static java.lang.String	PAGE_TECHNOLOGYSCOPES
static java.lang.String	PAGE_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultPalettePage() Default constructor.
protected	DefaultPalettePage(DefaultPalettePage.Builder builder)
	DefaultPalettePage(DefaultPalettePage.PageRecord record) Deprecated. Use the public static inner Builder class to construct a new instance.
	DefaultPalettePage(java.lang.String name, java.lang.String description, java.lang.String icon, java.lang.String pageId) Deprecated. Use the public static inner Builder class to construct a new instance.
	DefaultPalettePage(java.lang.String name, java.lang.String description, java.lang.String icon, java.lang.String pageId, java.lang.String pageEditor, java.lang.String projectConfiguration, java.util.List<java.lang.String> showForTypes, java.util.List<java.lang.String> technologyScopes, java.lang.String type, java.lang.String pageContext) Deprecated. Use the public static inner Builder class to construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addGroup(PaletteGroup group) Add Palette Group
java.lang.Object	getData(java.lang.Object key) Get data
java.lang.String	getDescription() Get description.
java.util.Collection<PaletteGroup>	getGroups() Get all Palette Groups
javax.swing.Icon	getIcon() Get Icon.
PaletteItem	getItem(java.lang.String itemId)
java.lang.String	getName() Get display name.
protected void	removeGroup(DefaultPaletteGroup group) Remove Palette Group
protected void	setData(java.lang.Object key, java.lang.Object data)
protected void	setDescription(java.lang.String description) Set description
protected void	setIcon(javax.swing.Icon icon) Set Icon.
protected void	setIcon(java.lang.String iconParm) Set Icon.
protected void	setName(java.lang.String name) Set display name.
java.lang.String	toString()

Methods inherited from class oracle.ide.palette2.PalettePage

dispose, equals, hashCode, isEmpty

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ICON

public static final java.lang.String DEFAULT_ICON

See Also:

Constant Field Values

PAGE_PAGEID

public static final java.lang.String PAGE_PAGEID

HashMap pageData keys

See Also:

Constant Field Values

PAGE_PAGEEDITOR

public static final java.lang.String PAGE_PAGEEDITOR

See Also:

Constant Field Values

PAGE_PROJECTCONFIGURATION

public static final java.lang.String PAGE_PROJECTCONFIGURATION

See Also:

Constant Field Values

PAGE_SHOWFORTYPES

public static final java.lang.String PAGE_SHOWFORTYPES

See Also:

Constant Field Values

PAGE_TECHNOLOGYSCOPES

public static final java.lang.String PAGE_TECHNOLOGYSCOPES

See Also:

Constant Field Values

PAGE_TYPE

public static final java.lang.String PAGE_TYPE

See Also:

Constant Field Values

PAGE_PAGECONTEXT

public static final java.lang.String PAGE_PAGECONTEXT

See Also:

Constant Field Values

Constructor Detail

DefaultPalettePage

public DefaultPalettePage()

Default constructor.

DefaultPalettePage

@Deprecated
public DefaultPalettePage(java.lang.String name,
                             java.lang.String description,
                             java.lang.String icon,
                             java.lang.String pageId,
                             java.lang.String pageEditor,
                             java.lang.String projectConfiguration,
                             java.util.List<java.lang.String> showForTypes,
                             java.util.List<java.lang.String> technologyScopes,
                             java.lang.String type,
                             java.lang.String pageContext)

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

Old constructor. This constructor takes a string list of showForTypes values as one of its arguments. This did not allow to specify the active page for a given document type.

A new constructor, taking a PageRecord as parameter, has been introduced. The new constructor should be used, it allows specifying the preferred page in the showForTypes paramenter. Copies Groups and Items.

DefaultPalettePage

@Deprecated
public DefaultPalettePage(java.lang.String name,
                             java.lang.String description,
                             java.lang.String icon,
                             java.lang.String pageId)

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

Convenience constructor to be used when only name, description, icon, and pageId need to be specified. All other parameters are defaulted to null.

DefaultPalettePage

@Deprecated
public DefaultPalettePage(DefaultPalettePage.PageRecord record)

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

Constructor, taking a PageRecord as parameter, has been introduced. The new constructor should be used, it allows specifying the preferred page in the showForTypes paramenter. Copies Groups and Items.

DefaultPalettePage

protected DefaultPalettePage(DefaultPalettePage.Builder builder)

Method Detail

getName

public java.lang.String getName()

Get display name.

See attribute shortLabel.

Specified by:

getName in class PalettePage

Returns:

display name.

setName

protected void setName(java.lang.String name)

Set display name.

See attribute shortLabel.

getDescription

public java.lang.String getDescription()

Get description.

See attribut longLabel.

Specified by:

getDescription in class PalettePage

Returns:

string.

setDescription

protected void setDescription(java.lang.String description)

Set description

See attribut longLabel.

getIcon

public javax.swing.Icon getIcon()

Get Icon.

Specified by:

getIcon in class PalettePage

Returns:

icon.

setIcon

protected void setIcon(java.lang.String iconParm)

Set Icon.

Parameters:

iconParm -

setIcon

protected void setIcon(javax.swing.Icon icon)

Set Icon.

See attribute icon.

Parameters:

icon -

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 PalettePage

setData

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

getItem

public PaletteItem getItem(java.lang.String itemId)

addGroup

public void addGroup(PaletteGroup group)

Add Palette Group

Parameters:

group -

removeGroup

protected void removeGroup(DefaultPaletteGroup group)

Remove Palette Group

Parameters:

group -

getGroups

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

Get all Palette Groups

Specified by:

getGroups in class PalettePage

Returns:

unmodifiable collection of paletteGroup's

toString

public java.lang.String toString()

Overrides:

toString in class PalettePage