|
Extension SDK 10.1.2 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ide.gallery.GalleryElement
Element for each item in the Object Gallery list.
Note that a GalleryElement
is not typically created by client code. To register a new gallery element, use GalleryManager.registerGalleryElement(ElementInfo)
.
Constructor Summary | |
GalleryElement() Default Constructor used for beans instantiation only. |
|
GalleryElement(Wizard wizard) Constructor. |
|
GalleryElement(Wizard wizard, java.lang.String name) Constructor. |
|
GalleryElement(Wizard wizard, java.lang.String name, java.lang.String[] wizardParams) Constructor. |
|
GalleryElement(Wizard wizard, java.lang.String name, java.lang.String[] wizardParams, javax.swing.Icon icon) Constructor. |
Method Summary | |
int |
compareTo(java.lang.Object o) |
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 Element s without having to test the object's type with the instanceof operator or having to downcast to a more specific type. |
java.lang.Object |
getData() Returns the data element associated with this Data . |
java.lang.String |
getDescription() |
protected javax.swing.Icon |
getDisabledIcon() Returns a disabled version of the GalleryElement 's Icon , if one can be created; otherwise, returns the normal icon, if one exists, or null if one does not exist. |
javax.swing.Icon |
getGalleryIcon() |
javax.swing.Icon |
getIcon() Returns an Icon that can be shown in association with this Displayable . |
java.lang.String |
getIconFile() |
java.lang.String |
getLongLabel() Returns a long label that can be displayed to the user. |
java.lang.String |
getName() |
java.lang.String |
getResClass() |
java.lang.String |
getShortLabel() Returns a short label that can be displayed to the user. |
java.lang.String[] |
getTechnologyKeys() |
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 |
getUnsorted() |
Wizard |
getWizard() |
java.lang.String |
getWizardClass() |
protected java.lang.String |
getWizardDescription() Deprecated. Replace with getLongLabel() . |
protected java.lang.String |
getWizardName() |
java.lang.String[] |
getWizardParameters() |
protected boolean |
isAvailable(Context context) Returns the enabled state of the GalleryElement in the specified Context . |
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 |
setDescription(java.lang.String description) |
void |
setIconFile(java.lang.String iconFile) |
void |
setName(java.lang.String name) |
void |
setResClass(java.lang.String resClass) |
void |
setTechnologyKeys(java.lang.String[] technologyKeys) |
void |
setUnsorted(boolean unsorted) |
void |
setWizardClass(java.lang.String clazz) |
void |
setWizardParameters(java.lang.String[] wizardParams) |
java.lang.String |
toString() Returns the Short Label displayed to a user. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public GalleryElement()
public GalleryElement(Wizard wizard)
wizard
- - reference to the wizardpublic GalleryElement(Wizard wizard, java.lang.String name)
wizard
- - reference to the wizardname
- - optional name to use isntead of the one provided by the wizard interfacepublic GalleryElement(Wizard wizard, java.lang.String name, java.lang.String[] wizardParams)
wizard
- - reference to the wizardname
- - optional name to use isntead of the one provided by the wizard interfacewizardParams
- - array of parameters to use for the wizard, these will mainly be used by the snippet support.public GalleryElement(Wizard wizard, java.lang.String name, java.lang.String[] wizardParams, javax.swing.Icon icon)
wizard
- - reference to the wizardname
- - optional name to use isntead of the one provided by the wizard interfacewizardParams
- - array of parameters to use for the wizard, these will mainly be used by the snippet support.icon
- - Large icon to use for the Wizard, if this parameter is null
, then the icon will be obtained from the Wizard
Method Detail |
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public boolean getUnsorted()
public void setUnsorted(boolean unsorted)
public void setWizardClass(java.lang.String clazz)
public java.lang.String getWizardClass()
public Wizard getWizard()
public void setName(java.lang.String name)
public java.lang.String getName()
public java.lang.String[] getWizardParameters()
public void setWizardParameters(java.lang.String[] wizardParams)
public void setIconFile(java.lang.String iconFile)
public java.lang.String getIconFile()
public java.lang.String[] getTechnologyKeys()
public void setTechnologyKeys(java.lang.String[] technologyKeys)
public java.lang.String getResClass()
public void setResClass(java.lang.String resClass)
public java.lang.Object getData()
Data
Data
. The getData()
method provides a standard means for getting the data element whether or not it is same object as its Element
object.getData
in interface Data
Data
instance.public javax.swing.Icon getGalleryIcon()
public boolean mayHaveChildren()
Element
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.
mayHaveChildren
in interface Element
true
if this Element
may contain child Element
s.public java.util.Iterator getChildren()
Element
Element
interface to provide a convenient way of getting an Iterator
over any contained child Element
s 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 Element
s or null
if there are no children.
getChildren
in interface Element
Iterator
over any child Element
s contained by this Element
. If there are no children, null
is returned.public Attributes getAttributes()
Element
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.getAttributes
in interface Element
public java.lang.String getShortLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. When possible, the returned label should be reasonably short enough to show in the navigator or explorer windows but long enough to clearly identify and distinguish the Displayable
.getShortLabel
in interface Displayable
Displayable
that can be shown to the user.public java.lang.String getLongLabel()
Displayable
String
is considered translatable and should therefore be placed in an appropriate resource file. The long label differs from the short label essentially on length. Usually the long label will only be shown on-demand and in places where horizontal space is more available. Examples are the status bar and tooltips.getLongLabel
in interface Displayable
Displayable
that can be shown to the user.public java.lang.String getToolTipText()
Displayable
Displayable
. In many cases it may be appropriate for this method to return the same value as Displayable.getLongLabel()
.getToolTipText
in interface Displayable
Displayable
.public javax.swing.Icon getIcon()
Displayable
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.getIcon
in interface Displayable
Icon
that is displayed in the Object Gallery.public java.lang.String toString()
Displayable
toString
method in java.lang.Object
.
Implementors of the Displayable
interface should override this as appropriate. The default implementation is the same as getShortLabel
toString
in interface Displayable
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
protected java.lang.String getWizardDescription()
getLongLabel()
.protected java.lang.String getWizardName()
protected boolean isAvailable(Context context)
GalleryElement
in the specified Context
.protected javax.swing.Icon getDisabledIcon()
GalleryElement
's Icon
, if one can be created; otherwise, returns the normal icon, if one exists, or null
if one does not exist.getIcon()
|
Extension SDK | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 1997, 2004, Oracle. All rights reserved.