Applications

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Extension SDK 10.1.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.ide.model
Class Applications

java.lang.Object
  oracle.ide.model.Applications

All Implemented Interfaces:: Data, Displayable, Element, Folder, Observer, Subject

public class Applications
extends java.lang.Object
implements Folder, Observer, Subject

The Applications class is used to wrap the Workspaces class in order to provide a different label when displayed in the application navigator. It observers the workspaces object and forwards any addition or removal of items from the workspaces object to observers of this class.

Field Summary
`static java.lang.String`	`APPLICATIONS`

Fields inherited from interface oracle.ide.addin.Subject

OBJECT_MODIFIED

Constructor Summary
`Applications(Workspaces workspaces)` Constructor.

Method Summary
`boolean`	`add(Element child)` Appends a child `Element` to the end of the `Folder`.
`void`	`attach(Observer o)` Registers an observer interested in being notified when the internal state of the class implementing the `Subject` interface changes.
`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`	`containsChild(Element child)` Returns `true` if the folder contains the specified child `Element`; returns `false` otherwise.
`void`	`detach(Observer o)` Unregisters an observer that is not interested anymore in being notified when the internal state of the class implementing the `Subject` interface changes.
`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`.
`javax.swing.Icon`	`getIcon()` Returns an `Icon` that can be shown in association with this `Displayable`.
`java.lang.String`	`getLongLabel()` Returns a long label that can be displayed to the user.
`java.lang.String`	`getShortLabel()` Returns a short label that can be displayed to the user.
`java.lang.String`	`getToolTipText()` Returns the tool tip text to show when the mouse pointer pauses over a UI component that represents this `Displayable`.
`protected Workspaces`	`getWorkspaces()`
`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 o, UpdateMessage msg)` Notifies all observers that the state of the subject has changed.
`boolean`	`remove(Element child)` Removes the specified child `Element`.
`void`	`removeAll()` Removes all children from the folder.
`int`	`size()` Returns the current number of children in the folder.
`java.lang.String`	`toString()` Returns the Short Label displayed to a user.
`void`	`update(java.lang.Object obj, UpdateMessage msg)` Notification message.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATIONS

public static final java.lang.String APPLICATIONS

See Also:: Constant Field Values

Constructor Detail

Applications

public Applications(Workspaces workspaces)

Constructor. Wraps the specified workspaces object.

Method Detail

getData

public java.lang.Object getData()

Description copied from interface: Data

Returns the data element associated with this Data. The getData() method provides a standard means for getting the data element whether or not it is same object as its Element object.

Specified by:: getData in interface Data

Returns:: the data object associated with this Data instance.

getShortLabel

public java.lang.String getShortLabel()

Description copied from interface: Displayable

Returns a short label that can be displayed to the user. Generally, the value of the returned 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.

Specified by:: getShortLabel in interface Displayable

Returns:: a short descriptive label of the Displayable that can be shown to the user.

getLongLabel

public java.lang.String getLongLabel()

Description copied from interface: Displayable

Returns a long label that can be displayed to the user. Generally, the value of the returned 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.

Specified by:: getLongLabel in interface Displayable

Returns:: a long descriptive label of the Displayable that can be shown to the user.

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 to be displayed for the Displayable.

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

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 child Elements.

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 over any child Elements contained by this Element. If there are no children, null is returned.

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 to show when the mouse pointer pauses over a UI component that represents this Displayable.

getAttributes

public 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