oracle.ide.model
Class CategoryFolder

java.lang.Object
  oracle.ide.model.CategoryFolder

All Implemented Interfaces:

Category, Data, Displayable, Element, Folder, Locatable

Direct Known Subclasses:

BusinessComponents, DatabaseObjects, DatabaseResources, Deployment, EnterpriseJavaBeans, MiscellaneousFiles, Resources, Sources, UMLModel, WebServices

public class CategoryFolder

extends java.lang.Object

implements Folder, Locatable, Category

The CategoryFolder class is responsible for collecting all nodes whose category cannot be determined.

Field Summary

protected java.util.ArrayList	children
static java.lang.String	DISPLAY_URL_PROTOCOL Deprecated. Replaced by ProtocolConstants.IDE_DISPLAY_PROTOCOL.

Fields inherited from interface oracle.ide.model.Category

UNDEFINED

Constructor Summary

CategoryFolder()

CategoryFolder(java.lang.String label)

CategoryFolder(java.net.URL url)

Method Summary

boolean	add(Element element) Add the specified Element to this 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.
boolean	checkRefresh(UpdateMessage change)
boolean	containsChild(Element child) Returns true if the folder contains the specified child Element; returns false otherwise.
Attributes	getAttributes() Category elements do not define any attributes.
int	getCategory() Get the bit field identifying the different categories this data node falls under.
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.Object	getData() Gets the data element that implements this interface.
protected URLPath	getExcludePath() Returns the URLPath which is to be excluded from consideration when determining whether a particular Locatable element is on the sourcepath.
javax.swing.Icon	getIcon() Returns an Icon that can be shown in association with this Displayable.
java.lang.String	getLongLabel() Gets a fully qualified label for display purpose.
Folder	getOwner()
java.lang.String	getShortLabel() Gets a short label for display purpose.
URLPath	getSourcePath()
java.lang.String	getToolTipText() Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this Displayable.
java.net.URL	getURL() Returns the URL that identifies this Locatable.
boolean	isStrict() When true indicates that the filter used to filter this folder children should be strict with name and children
static boolean	matchElement(Element element, CategoryFolder category)
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) Remove the specified Element from this Folder.
void	removeAll() Removes all children from the folder.
void	setCategory(int category)
void	setIcon(javax.swing.Icon icon)
void	setOwner(Folder owner)
void	setURL(java.net.URL url) Sets the URL associated with this Locatable.
int	size() Returns the current number of children in the folder.
java.lang.String	toString() Returns the Short Label displayed to a user.
protected boolean	useFactory() If the children of this folder should be created using a factory return true from this method.

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_URL_PROTOCOL

public static final java.lang.String DISPLAY_URL_PROTOCOL

Deprecated. Replaced by ProtocolConstants.IDE_DISPLAY_PROTOCOL.

See Also:

Constant Field Values

children

protected java.util.ArrayList children

Constructor Detail

CategoryFolder

public CategoryFolder()

CategoryFolder

public CategoryFolder(java.lang.String label)

CategoryFolder

public CategoryFolder(java.net.URL url)

Method Detail

add

public boolean add(Element element)

Add the specified Element to this Folder.

Specified by:

add in interface Folder

remove

public boolean remove(Element element)

Remove the specified Element from this Folder.

Specified by:

remove in interface Folder

Parameters:

element - Element to be removed from this container.

canRemove

public boolean canRemove(Element element)

Description copied from interface: Folder

Other classes can call this method to determine whether the specified Element can be removed from this Folder.

Specified by:

canRemove in interface Folder

Parameters:

element - the Element being checked for removal from this folder

Returns:

TRUE if the specified element can be removed from this folder in the specified context. Quick responses are appreciated, since this method is used to enable/disable the Delete accelerator key in the Navigator with every context change.

canAdd

public boolean canAdd(Element element)

Description copied from interface: Folder

Other classes can call this method to determine whether the given Element can be added to the Folder.

Specified by:

canAdd in interface Folder

Parameters:

element - the Element that is about to be added to this Folder.

Returns:

true if the specified Element can be added to this Folder; false if the Element cannot be added.

containsChild

public boolean containsChild(Element child)

Description copied from interface: Folder

Returns true if the folder contains the specified child Element; returns false otherwise.

Specified by:

containsChild in interface Folder

size

public int size()

Description copied from interface: Folder

Returns the current number of children in the folder.

Specified by:

size in interface Folder

removeAll

public void removeAll()

Description copied from interface: Folder

Removes all children from the folder.

Specified by:

removeAll in interface Folder

getData

public java.lang.Object getData()

Gets the data element that implements this interface.

Specified by:

getData in interface Data

Returns:

object implementing this interface.

getShortLabel

public 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

public 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

public 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

getToolTipText

public 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

toString

public java.lang.String toString()

Description copied from interface: Displayable

Returns the Short Label displayed to a user. This overrides the toString method in java.lang.Object.

Implementors of the Displayable interface should override this as appropriate. The default implementation is the same as getShortLabel

Specified by:

toString in interface Displayable

Returns:

the short label for the folder

getAttributes

public Attributes getAttributes()

Category elements do not define any attributes. This method returns an Attributes object with the attribute ElementAttributes.NODE set.

Specified by:

getAttributes in interface Element

mayHaveChildren

public 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

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

setURL

public void setURL(java.net.URL url)

Description copied from interface: Locatable

Sets the URL associated with this Locatable. It is important that the URL only be changed when the Locatable has just been created or when all caches keyed on the previous URL can also be updated.

Specified by:

setURL in interface Locatable

Parameters:

url - The URL to set.

getURL

public java.net.URL getURL()

Description copied from interface: Locatable

Returns the URL that identifies this Locatable. Parts of the IDE will use the value of this URL as a hash key for caching UI components for this Locatable. Therefore, URL uniqueness is important.

Specified by:

getURL in interface Locatable

Returns:

The URL identifying this Locatable.

getCategory

public int getCategory()

Description copied from interface: Category

Get the bit field identifying the different categories this data node falls under.

Specified by:

getCategory in interface Category

Returns:

the category types.

getOwner

public Folder getOwner()

setOwner

public void setOwner(Folder owner)

setCategory

public void setCategory(int category)

setIcon

public void setIcon(javax.swing.Icon icon)

checkRefresh

public boolean checkRefresh(UpdateMessage change)

getSourcePath

public URLPath getSourcePath()

isStrict

public boolean isStrict()

When true indicates that the filter used to filter this folder children should be strict with name and children

matchElement

public static boolean matchElement(Element element,
                                   CategoryFolder category)

getExcludePath

protected URLPath getExcludePath()

Returns the URLPath which is to be excluded from consideration when determining whether a particular Locatable element is on the sourcepath.

useFactory

protected boolean useFactory()

If the children of this folder should be created using a factory return true from this method. This implementation always returns false.