oracle.ide.palette2

Class DefaultPaletteItem

java.lang.Object

oracle.ide.palette2.PaletteItem

oracle.ide.palette2.DefaultPaletteItem

public class DefaultPaletteItem
extends PaletteItem

DefaultPaletteItem - class provides a default PaletteItem 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, DefaultPaletteSection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultPaletteItem.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ITEM_CLASSNAME
static java.lang.String	ITEM_CLASSPATH
static java.lang.String	ITEM_CODESNIPPET
static java.lang.String	ITEM_DND_TRANSFERDATA
static java.lang.String	ITEM_EDITOR HashMap data keys
static java.lang.String	ITEM_EXTENSION
static java.lang.String	ITEM_INFO
static java.lang.String	ITEM_LIBRARY
static java.lang.String	ITEM_TECHNOLOGYSCOPES
static java.lang.String	ITEM_TYPE
static java.lang.String	ITEM_WEIGHT

Fields inherited from class oracle.ide.palette2.PaletteItem

PALETTE_ITEM_FLAVOR

Constructor Summary

Constructors

Constructor and Description
DefaultPaletteItem() Default Constructor.
DefaultPaletteItem(java.lang.String name, java.lang.String description, javax.swing.Icon icon, java.lang.String itemId, java.lang.String providerId, java.lang.String pageEditor, java.util.List<java.lang.String> technologyScopes, java.lang.String type, java.lang.String info, java.lang.String classPath, java.lang.String className, java.lang.String library, java.lang.String weight, java.lang.String helpable, java.lang.String searchTextContext) Deprecated. Use the public static inner Builder class to construct a new instance.
DefaultPaletteItem(java.lang.String name, java.lang.String description, java.lang.String icon, java.lang.String itemId, java.lang.String providerId, java.lang.String pageEditor, java.util.List<java.lang.String> technologyScopes, java.lang.String type, java.lang.String info, java.lang.String classPath, java.lang.String className, java.lang.String library, java.lang.String weight, java.lang.String helpable, java.lang.String searchTextContext) Deprecated. Use the public static inner Builder class to construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Equals
java.lang.Object	getData(java.lang.Object key) Get data
java.lang.String	getDescription() Get description.
java.lang.String	getHelpable() Get help link.
javax.swing.Icon	getIcon() Get Icon.
java.lang.String	getIconURL()
java.lang.String	getItemId() Get Item Id
javax.swing.Icon	getLargeIcon() Get the large icon (usually 32 pix.
java.lang.String	getLargeIconURL()
java.lang.String	getName() Get display name.
java.lang.String	getProviderId() Get Provider Id.
java.lang.String	getSearchTextContext() Get search text context callback name.
void	setData(java.lang.Object key, java.lang.Object data)
protected void	setDescription(java.lang.String description) Set description
protected void	setHelpable(java.lang.String helpable) Set help link.
protected void	setIcon(javax.swing.Icon icon) Set Icon
protected void	setIcon(java.lang.String iconParm) Set Icon.
protected void	setItemId(java.lang.String itemId) Set Item Id
protected void	setLargeIcon(javax.swing.Icon largeIcon)
protected void	setName(java.lang.String name) Set display name.
protected void	setProviderId(java.lang.String providerId) Get Provider Id.
protected void	setSearchTextContext(java.lang.String searchTextContext) Set search text context callback name.
java.lang.String	toString()

Methods inherited from class oracle.ide.palette2.PaletteItem

dispose, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

ITEM_EDITOR

public static final java.lang.String ITEM_EDITOR

HashMap data keys

See Also:

Constant Field Values

ITEM_INFO

public static final java.lang.String ITEM_INFO

See Also:

Constant Field Values

ITEM_CLASSPATH

public static final java.lang.String ITEM_CLASSPATH

See Also:

Constant Field Values

ITEM_CLASSNAME

public static final java.lang.String ITEM_CLASSNAME

See Also:

Constant Field Values

ITEM_LIBRARY

public static final java.lang.String ITEM_LIBRARY

See Also:

Constant Field Values

ITEM_TECHNOLOGYSCOPES

public static final java.lang.String ITEM_TECHNOLOGYSCOPES

See Also:

Constant Field Values

ITEM_TYPE

public static final java.lang.String ITEM_TYPE

See Also:

Constant Field Values

ITEM_WEIGHT

public static final java.lang.String ITEM_WEIGHT

See Also:

Constant Field Values

ITEM_CODESNIPPET

public static final java.lang.String ITEM_CODESNIPPET

See Also:

Constant Field Values

ITEM_EXTENSION

public static final java.lang.String ITEM_EXTENSION

See Also:

Constant Field Values

ITEM_DND_TRANSFERDATA

public static final java.lang.String ITEM_DND_TRANSFERDATA

See Also:

Constant Field Values

Constructor Detail

DefaultPaletteItem

public DefaultPaletteItem()

Default Constructor.

DefaultPaletteItem

@Deprecated
public DefaultPaletteItem(java.lang.String name,
                             java.lang.String description,
                             java.lang.String icon,
                             java.lang.String itemId,
                             java.lang.String providerId,
                             java.lang.String pageEditor,
                             java.util.List<java.lang.String> technologyScopes,
                             java.lang.String type,
                             java.lang.String info,
                             java.lang.String classPath,
                             java.lang.String className,
                             java.lang.String library,
                             java.lang.String weight,
                             java.lang.String helpable,
                             java.lang.String searchTextContext)

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

Constructor for a declared item component from the extension manifest

DefaultPaletteItem

@Deprecated
public DefaultPaletteItem(java.lang.String name,
                             java.lang.String description,
                             javax.swing.Icon icon,
                             java.lang.String itemId,
                             java.lang.String providerId,
                             java.lang.String pageEditor,
                             java.util.List<java.lang.String> technologyScopes,
                             java.lang.String type,
                             java.lang.String info,
                             java.lang.String classPath,
                             java.lang.String className,
                             java.lang.String library,
                             java.lang.String weight,
                             java.lang.String helpable,
                             java.lang.String searchTextContext)

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

Constructor for a declared item component from the extension manifest Takes and Icon.

Method Detail

getName

public java.lang.String getName()

Get display name.

Specified by:

getName in class PaletteItem

Returns:

display name.

setName

protected void setName(java.lang.String name)

Set display name.

getDescription

public java.lang.String getDescription()

Get description.

Specified by:

getDescription in class PaletteItem

Returns:

string.

setDescription

protected void setDescription(java.lang.String description)

Set description

getIcon

public javax.swing.Icon getIcon()

Get Icon.

Specified by:

getIcon in class PaletteItem

Returns:

icon.

getIconURL

public java.lang.String getIconURL()

setIcon

protected void setIcon(java.lang.String iconParm)

Set Icon.

Parameters:

iconParm -

setIcon

protected void setIcon(javax.swing.Icon icon)

Set Icon

Parameters:

icon -

getLargeIcon

public javax.swing.Icon getLargeIcon()

Description copied from class: PaletteItem

Get the large icon (usually 32 pix. X 32 pix.), if available. This is an optional (though recommended) operation.

Overrides:

getLargeIcon in class PaletteItem

Returns:

the large icon, or null if none is available

getLargeIconURL

public java.lang.String getLargeIconURL()

setLargeIcon

protected void setLargeIcon(javax.swing.Icon largeIcon)

getItemId

public java.lang.String getItemId()

Get Item Id

Specified by:

getItemId in class PaletteItem

Returns:

itemId.

setItemId

protected void setItemId(java.lang.String itemId)

Set Item Id

Parameters:

itemId. -

getProviderId

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

Specified by:

getProviderId in class PaletteItem

Returns:

string.

setProviderId

protected void setProviderId(java.lang.String providerId)

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.

getSearchTextContext

public java.lang.String getSearchTextContext()

Get search text context callback name.

Specified by:

getSearchTextContext in class PaletteItem

Returns:

searchTextContext

setSearchTextContext

protected void setSearchTextContext(java.lang.String searchTextContext)

Set search text context callback name.

Parameters:

searchTextContext -

getHelpable

public java.lang.String getHelpable()

Get help link.

Specified by:

getHelpable in class PaletteItem

Returns:

helpable

setHelpable

protected void setHelpable(java.lang.String helpable)

Set help link.

Parameters:

helpable -

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 PaletteItem

setData

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

equals

public boolean equals(java.lang.Object obj)

Equals

Overrides:

equals in class PaletteItem

Parameters:

obj -

Returns:

boolean

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object