oracle.ide.palette

Interface PaletteItem

All Superinterfaces:

Displayable, Element

public interface PaletteItem
extends Element

The PaletteItem class represents the Object model for items on the component palette.

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.datatransfer.DataFlavor	PALETTE_ITEM_FLAVOR Drag and Drop DataFlavor representing a PaletteItem.

Method Summary

Methods

Modifier and Type	Method and Description
void	attach(Observer observer)
boolean	canShow() Returns if this particular can make itself visible
void	detach(Observer observer)
Attributes	getAttributes() This method returns an Attributes object that encodes the attributes of the Element.
java.util.Iterator	getChildren() This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.
java.lang.String	getClassName() Return ClassName
java.lang.String	getClassPath() Return Classpath
java.lang.Object	getData() Returns the data object associated with this Element.
java.lang.String	getEditor() Retrieves the editor associated with this palette item.
javax.swing.Icon	getIcon() Returns an Icon that can be shown in association with this Displayable.
java.lang.String	getInitializer()
java.lang.String	getItemBeanInfo()
boolean	getItemCanRemove()
java.lang.String	getItemCodeSnippet()
java.lang.String	getItemEditor()
java.lang.String	getItemHelpable()
java.lang.String	getItemIcon()
java.lang.String	getItemInfo()
boolean	getItemIsPersistent()
java.lang.String	getItemLibrary()
java.lang.String	getItemLongLabel()
java.lang.String	getItemProjectConfiguration()
java.lang.String	getItemShortLabel()
java.lang.String	getItemTechnologyScope()
java.lang.String	getItemType()
float	getItemWeight()
java.lang.String	getLibrary() Return Library
java.lang.String	getLongLabel() Gets a fully qualified label for display purpose.
java.lang.String	getShortLabel() Gets a short label for display purpose.
java.lang.String	getTechnologyScope() Retreives the technology scope associated with this palette item.
java.lang.String	getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable.
boolean	hasItem()
boolean	isPointer()
boolean	isResetItem() Returns true if item is a reset item "Pointer"
boolean	mayHaveChildren() This method is part of the Element interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof operator or having to downcast to a more specific type.
void	notifyObservers(java.lang.Object object, UpdateMessage change)
void	setCanShow(boolean canShow) Set if this item can make itself visible the next it's parent folder shows itself.
void	setEditor(java.lang.String editor) Sets the current editor to use with this palette item.
void	setIcon(javax.swing.Icon icon)
void	setItemBeanInfo(java.lang.String beanInfo)
void	setItemCanRemove(boolean cr)
void	setItemCodeSnippet(java.lang.String s)
void	setItemEditor(java.lang.String editor)
void	setItemHelpable(java.lang.String help)
void	setItemIcon(java.lang.String icon)
void	setItemInfo(java.lang.String info)
void	setItemIsPersistent(boolean persist)
void	setItemLibrary(java.lang.String library)
void	setItemLongLabel(java.lang.String longLabel)
void	setItemProjectConfiguration(java.lang.String projectConfiguration)
void	setItemShortLabel(java.lang.String shortLabel)
void	setItemTechnologyScope(java.lang.String techScope)
void	setItemType(java.lang.String type)
void	setItemWeight(float weight)
void	setLongLabel(java.lang.String longLabel)
void	setShortLabel(java.lang.String shortLabel)
void	setTechnologyScope(java.lang.String techScope) Sets the technology scope to use with this palette item.

Methods inherited from interface oracle.ide.model.Displayable

toString

Field Detail

PALETTE_ITEM_FLAVOR

static final java.awt.datatransfer.DataFlavor PALETTE_ITEM_FLAVOR

Drag and Drop DataFlavor representing a PaletteItem.

Method Detail

getClassName

java.lang.String getClassName()

Return ClassName

getClassPath

java.lang.String getClassPath()

Return Classpath

getLibrary

java.lang.String getLibrary()

Return Library

Returns:

String

getInitializer

java.lang.String getInitializer()

isPointer

boolean isPointer()

canShow

boolean canShow()

Returns if this particular can make itself visible

Returns:

true - if it can show itself, false otherwise.

setCanShow

void setCanShow(boolean canShow)

Set if this item can make itself visible the next it's parent folder shows itself.

getEditor

java.lang.String getEditor()

Retrieves the editor associated with this palette item.

Returns:

editor

setEditor

void setEditor(java.lang.String editor)

Sets the current editor to use with this palette item.

Parameters:

editor -

setTechnologyScope

void setTechnologyScope(java.lang.String techScope)

Sets the technology scope to use with this palette item.

Parameters:

techScope -

getTechnologyScope

java.lang.String getTechnologyScope()

Retreives the technology scope associated with this palette item.

isResetItem

boolean isResetItem()

Returns true if item is a reset item "Pointer"

hasItem

boolean hasItem()

Returns:

returns true if this item's PaletteItemUI is 'active' and 'selected'

getItemIcon

java.lang.String getItemIcon()

setItemIcon

void setItemIcon(java.lang.String icon)

getItemShortLabel

java.lang.String getItemShortLabel()

setItemShortLabel

void setItemShortLabel(java.lang.String shortLabel)

getItemLongLabel

java.lang.String getItemLongLabel()

setItemLongLabel

void setItemLongLabel(java.lang.String longLabel)

getItemInfo

java.lang.String getItemInfo()

setItemInfo

void setItemInfo(java.lang.String info)

getItemType

java.lang.String getItemType()

setItemType

void setItemType(java.lang.String type)

getItemWeight

float getItemWeight()

setItemWeight

void setItemWeight(float weight)

getItemEditor

java.lang.String getItemEditor()

setItemEditor

void setItemEditor(java.lang.String editor)

getItemLibrary

java.lang.String getItemLibrary()

setItemLibrary

void setItemLibrary(java.lang.String library)

getItemBeanInfo

java.lang.String getItemBeanInfo()

setItemBeanInfo

void setItemBeanInfo(java.lang.String beanInfo)

getItemCodeSnippet

java.lang.String getItemCodeSnippet()

setItemCodeSnippet

void setItemCodeSnippet(java.lang.String s)

getItemIsPersistent

boolean getItemIsPersistent()

setItemIsPersistent

void setItemIsPersistent(boolean persist)

getItemHelpable

java.lang.String getItemHelpable()

setItemHelpable

void setItemHelpable(java.lang.String help)

getItemProjectConfiguration

java.lang.String getItemProjectConfiguration()

setItemProjectConfiguration

void setItemProjectConfiguration(java.lang.String projectConfiguration)

getItemTechnologyScope

java.lang.String getItemTechnologyScope()

setItemTechnologyScope

void setItemTechnologyScope(java.lang.String techScope)

getItemCanRemove

boolean getItemCanRemove()

setItemCanRemove

void setItemCanRemove(boolean cr)

attach

void attach(Observer observer)

detach

void detach(Observer observer)

notifyObservers

void notifyObservers(java.lang.Object object,
                   UpdateMessage change)

mayHaveChildren

boolean mayHaveChildren()

Description copied from interface: Element

This method is part of the Element interface to provide a convenient way of determining whether an object may have children without having to test the object's type with the instanceof operator or having to downcast to a more specific type.

An implementation of Element that represents a leaf in a tree structure should return false from this method. An implementation of Element that could represent a non-leaf in a tree structure should return true from this method, even if it does not currently contain any children.

Specified by:

mayHaveChildren in interface Element

Returns:

true if this Element may contain children.

getChildren

java.util.Iterator getChildren()

Description copied from interface: Element

This method is part of the Element interface to provide a convenient way of getting an Iterator over any contained child Elements without having to test the object's type with the instanceof operator or having to downcast to a more specific type.

An implementation of Element that represents a leaf in a tree structure should return null from this method. An implementation of Element that could represent a non-leaf in a tree structure should return either an Iterator over the child Elements or null if there are no children.

Specified by:

getChildren in interface Element

Returns:

an Iterator of any children held by this Element, else null.

getAttributes

Attributes getAttributes()

Description copied from interface: Element

This method returns an Attributes object that encodes the attributes of the Element. Changing the attribute settings on the return object changes the element attributes. Subclasses should use their super class attributes object to define their own attributes. This allows subclasses to inherit their super class attributes. If a subclass does not wish to inherit attributes, they should first call getAttributes().clear() and define new attributes.

Specified by:

getAttributes in interface Element

getData

java.lang.Object getData()

Description copied from interface: Element

Returns the data object associated with this Element. Implementations will often simply return this, since the Element is often its own data object. If the implementation returns an object other than this, be sure to set ElementAttributes.DECORATES_DATA_ELEMENT.

Specified by:

getData in interface Element

Returns:

the data object associated with this Element instance.

getShortLabel

java.lang.String getShortLabel()

Gets a short label for display purpose.

Specified by:

getShortLabel in interface Displayable

Returns:

a short descriptive label. For example; an unqaualified file name.

getLongLabel

java.lang.String getLongLabel()

Gets a fully qualified label for display purpose.

Specified by:

getLongLabel in interface Displayable

Returns:

a long descriptive label. For example; a fully qualified file name.

getIcon

javax.swing.Icon getIcon()

Description copied from interface: Displayable

Returns an Icon that can be shown in association with this Displayable. Typically the icon will be used in a tree control or list control. Therefore the icon must fit naturally within the space normally given to items within those controls. Such icons are usually 16x16 in size or, if there is a one-pixel transparent padding around the edge, 18x18 in size. It is strongly recommended that icons returned by this method be either 16x16 or 18x18 in size. If null is returned, the control may show a default icon, or it may show no icon, whichever is appropriate.

Specified by:

getIcon in interface Displayable

Returns:

the Icon for this node instance

setShortLabel

void setShortLabel(java.lang.String shortLabel)

setLongLabel

void setLongLabel(java.lang.String longLabel)

setIcon

void setIcon(javax.swing.Icon icon)

getToolTipText

java.lang.String getToolTipText()

Description copied from interface: Displayable

Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel().

Specified by:

getToolTipText in interface Displayable

Returns:

the ToolTip for this node instance