|
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.GalleryFolder
Container used in the gallery category tree, which may contain both sub-folders and gallery items.
Field Summary | |
protected static java.text.Collator |
COLLATOR |
Constructor Summary | |
GalleryFolder() Default constructor, used for beans instantiation. |
|
GalleryFolder(java.lang.String name) Constructor. |
Method Summary | |
boolean |
add(Element element) Appends a child Element to the end of the Folder . |
boolean |
canAdd(Element element) Other classes can call this method to determine whether the given Element can be added to the Folder . |
boolean |
canRemove(Element element) Other classes can call this method to determine whether the specified Element can be removed from this Folder . |
int |
compareTo(java.lang.Object o) |
boolean |
containsChild(Element element) Returns true if the folder contains the specified child Element ; returns false otherwise. |
GalleryFolder |
createFolder(java.lang.String folderName) Returns the child GalleryFolder with the specified name if one exists, or creates a new child GalleryFolder if one does not exist. |
protected GalleryFolder |
findFolder(java.lang.String folderName) Returns the first descendant GalleryFolder with the specified name, using a depth-first search of all descendants; returns null if no descendant folder was found. |
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. |
protected java.util.List |
getChildrenDirectly() Subclasses can override this method to change the way that the list of children is determined and stored. |
java.lang.Object |
getData() Returns the data element associated with this Data . |
java.lang.Object |
getElementAt(int index) Deprecated. Replace with getList() .get(int) . |
protected GalleryElement[] |
getElementChildren() |
GalleryFolder |
getFolder(java.lang.String folderName) Returns the child GalleryFolder with the specified name, or returns null if no such child folder exists. |
protected GalleryFolder[] |
getFolderChildren() |
GalleryElement |
getGalleryElement(java.lang.String elementName) |
GalleryFolder |
getGalleryFolder(java.lang.String folderName) Deprecated. recursive folder lookup is ill-advised -- replace with non-recursive getFolder(String) or createFolder(String) . |
javax.swing.Icon |
getIcon() Returns an Icon that can be shown in association with this Displayable . |
java.util.List |
getList() |
java.lang.String |
getLongLabel() Returns a long label that can be displayed to the user. |
java.lang.String |
getName() |
java.lang.String |
getShortLabel() Returns a short label that can be displayed to the user. |
int |
getSize() Deprecated. Replace with size() . |
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() |
protected boolean |
isExpanded() |
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. |
boolean |
remove(Element element) Removes the specified child Element . |
void |
removeAll() Removes all children from the folder. |
protected void |
setChildrenDirectly(java.util.List children) Subclasses can override this method to change the way that the list of children is determined and stored. |
protected void |
setExpanded(boolean expanded) |
void |
setList(java.util.List list) |
void |
setName(java.lang.String name) |
void |
setUnsorted(boolean unsorted) |
int |
size() Returns the current number of children in the folder. |
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 |
Field Detail |
protected static final java.text.Collator COLLATOR
Constructor Detail |
public GalleryFolder()
public GalleryFolder(java.lang.String name)
name
- - name of this folderMethod Detail |
public java.util.List getList()
public void setList(java.util.List list)
public java.lang.String getName()
public void setName(java.lang.String name)
public boolean getUnsorted()
public void setUnsorted(boolean unsorted)
public GalleryFolder getFolder(java.lang.String folderName)
GalleryFolder
with the specified name, or returns null
if no such child folder exists.public GalleryFolder createFolder(java.lang.String folderName)
GalleryFolder
with the specified name if one exists, or creates a new child GalleryFolder
if one does not exist.public GalleryFolder getGalleryFolder(java.lang.String folderName)
getFolder(String)
or createFolder(String)
.GalleryFolder
with the specified name.GalleryFolder
with the specified name, or null
if no such named folder existspublic GalleryElement getGalleryElement(java.lang.String elementName)
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 boolean canAdd(Element element)
Folder
Element
can be added to the Folder
.canAdd
in interface Folder
element
- the Element
that is about to be added to this Folder
.true
if the specified Element
can be added to this Folder
; false
if the Element
cannot be added.public boolean add(Element element)
Folder
Element
to the end of the Folder
.add
in interface Folder
public boolean canRemove(Element element)
Folder
Element
can be removed from this Folder
.canRemove
in interface Folder
element
- the Element
that is about to be removed from this Folder
.true
if the specified Element
can be removed from this Folder
; false
if the Element
cannot be removed.public boolean remove(Element element)
Folder
Element
. If the child object appears more than once, only the first instance is removed.remove
in interface Folder
element
- The child object to remove.public void removeAll()
Folder
removeAll
in interface Folder
public boolean containsChild(Element element)
Folder
true
if the folder contains the specified child Element
; returns false
otherwise.containsChild
in interface Folder
public int size()
Folder
size
in interface Folder
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
to be displayed for the Displayable
.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 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 int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public int getSize()
size()
.public java.lang.Object getElementAt(int index)
getList()
.get(int)
.protected boolean isExpanded()
protected void setExpanded(boolean expanded)
protected java.util.List getChildrenDirectly()
protected void setChildrenDirectly(java.util.List children)
protected GalleryElement[] getElementChildren()
protected GalleryFolder[] getFolderChildren()
protected GalleryFolder findFolder(java.lang.String folderName)
GalleryFolder
with the specified name, using a depth-first search of all descendants; returns null
if no descendant folder was found.
|
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.