oracle.ide.gallery
Class ElementInfo

java.lang.Object
  oracle.ide.gallery.ElementInfo

public final class ElementInfo

extends java.lang.Object

Defines the information used to specify a gallery element.

See Also:

GalleryManager.registerGalleryElement(ElementInfo), GalleryManager.unregisterGalleryElement(ElementInfo)

Constructor Summary

ElementInfo(java.lang.String[] path, java.lang.String clazz, java.lang.String[] params, java.lang.String name, java.lang.String description, java.lang.String iconFile, boolean unsorted)
Constructs an ElementInfo instance for defining a gallery element given the specified information.

ElementInfo(java.lang.String categoryName, java.lang.String folderName, java.lang.String clazz, java.lang.String[] params, java.lang.String name, java.lang.String description, java.lang.String iconFile, boolean unsorted)
Constructs an ElementInfo instance for defining a gallery element given the specified information.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()
java.lang.String	getIconFile()
java.lang.String	getName()
java.lang.String[]	getPath()
java.lang.String	getResClass()
java.lang.String[]	getTechnologyKeys()
boolean	getUnsorted()
java.lang.String	getWizardClass()
java.lang.String[]	getWizardParameters()
void	setDescription(java.lang.String description)
void	setIconFile(java.lang.String iconFile)
void	setName(java.lang.String name)
void	setPath(java.lang.String folderName)
void	setPath(java.lang.String[] path)
void	setPath(java.lang.String categoryName, java.lang.String folderName)
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[] params)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ElementInfo

public ElementInfo(java.lang.String[] path,
                   java.lang.String clazz,
                   java.lang.String[] params,
                   java.lang.String name,
                   java.lang.String description,
                   java.lang.String iconFile,
                   boolean unsorted)

Constructs an ElementInfo instance for defining a gallery element given the specified information.

Parameters:

path - An array of strings representing the gallery folder path to the new element. When registering a new gallery element, if any folder in the path does not exist, it will be created.

For example, new String[] { "General", "Projects" }.

clazz - The string name of the class for the new gallery element.

name - The name of the gallery element to be displayed in the gallery item list; if the gallery element implements the Displayable interface, then the name is taken from the Displayable.getShortLabel() method instead.

description - The description of the gallery element to be displayed in the gallery description area; if the gallery element implements the Displayable interface, then the name is taken from the Displayable.getLongLabel() method instead.

iconFile - The path for the icon file of the gallery element, relative to the class path; if null and the gallery element implements the Displayable interface, then the icon is taken from the Displayable.getIcon() method.

unsorted - Flag indicating whether or not the gallery element should be sorted lexicographically with the rest of the elements in the same gallery folder; if true, then the element will appear unsorted at the top item list.

params - The parameters to pass when invoking the gallery element.

ElementInfo

public ElementInfo(java.lang.String categoryName,
                   java.lang.String folderName,
                   java.lang.String clazz,
                   java.lang.String[] params,
                   java.lang.String name,
                   java.lang.String description,
                   java.lang.String iconFile,
                   boolean unsorted)

Constructs an ElementInfo instance for defining a gallery element given the specified information.

Parameters:

categoryName - The name of the top-level folder containing the gallery element; if null, then the folderName parameter is used to specify the top-level folder.

folderName - The folder containing the gallery element, which may not be null.

See Also:

ElementInfo(String[],String,String[],String,String,String,boolean)

Method Detail

getPath

public java.lang.String[] getPath()

setPath

public void setPath(java.lang.String[] path)

setPath

public void setPath(java.lang.String folderName)

setPath

public void setPath(java.lang.String categoryName,
                    java.lang.String folderName)

getWizardClass

public java.lang.String getWizardClass()

setWizardClass

public void setWizardClass(java.lang.String clazz)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getIconFile

public java.lang.String getIconFile()

setIconFile

public void setIconFile(java.lang.String iconFile)

getWizardParameters

public java.lang.String[] getWizardParameters()

setWizardParameters

public void setWizardParameters(java.lang.String[] params)

getUnsorted

public boolean getUnsorted()

setUnsorted

public void setUnsorted(boolean unsorted)

getTechnologyKeys

public java.lang.String[] getTechnologyKeys()

setTechnologyKeys

public void setTechnologyKeys(java.lang.String[] technologyKeys)

getResClass

public java.lang.String getResClass()

setResClass

public void setResClass(java.lang.String resClass)

equals

public boolean equals(java.lang.Object obj)