Extension SDK 10.1.2

oracle.ide.model
Class MiscellaneousFolder

java.lang.Object
  extended byoracle.ide.model.DefaultDisplayable
      extended byoracle.ide.model.DefaultElement
          extended byoracle.ide.model.DefaultDocument
              extended byoracle.ide.model.DefaultNode
                  extended byoracle.ide.model.DataNode
                      extended byoracle.ide.model.DataContainer
                          extended byoracle.ide.model.MiscellaneousFolder
All Implemented Interfaces:
Category, Container, Data, Dirtyable, Displayable, Document, Element, Folder, LazyLoadable, Locatable, Node, Subject

public class MiscellaneousFolder
extends DataContainer


Field Summary
static java.lang.String BASENAME
          The base filename of the file where the contents of the top-level 'Miscellaneous Files' folder are stored.
static java.lang.String EXT
          The file extension of the file where the contents of the top-level 'Miscellaneous Files' folder are stored.
static java.lang.String NAMESPACE_URI
          The namespace URI.
static java.lang.String ROOT_TAG
          The XML root tag name.
 
Fields inherited from class oracle.ide.model.DataContainer
_children
 
Fields inherited from class oracle.ide.model.DataNode
_objectStore
 
Fields inherited from interface oracle.ide.addin.Subject
OBJECT_MODIFIED
 
Fields inherited from interface oracle.ide.model.Category
UNDEFINED
 
Constructor Summary
MiscellaneousFolder()
          Default constructor, used for beans instantiation.
 
Method Summary
 boolean canAdd(Element element)
          Part of the Folder interface.
 void checkAddToSystem()
           
 void checkRemoveFromSystem()
           
 void close()
          Closes the Document and unloads any associated 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.
 boolean remove(Element element)
          Part of the Folder interface.
 
Methods inherited from class oracle.ide.model.DataContainer
add, add, add, canRemove, containsChild, copyToImpl, getBaseDirectory, getChildren, getListOfChildren, mayHaveChildren, remove, removeAll, removeAll, resetSubDirtyableOwners, setListOfChildren, setSubDirtyableOwner, size
 
Methods inherited from class oracle.ide.model.DataNode
currentObjectStore, fireObjectOpened, getURL, open, open, reopen, save, setObjectStore
 
Methods inherited from class oracle.ide.model.DefaultNode
equalsImpl, getCategory, setURL
 
Methods inherited from class oracle.ide.model.DefaultDocument
attach, copyToImpl, createSubject, detach, ensureOpen, equalsImpl, getInputStream, getSubject, getTimestamp, getTimestampDirectly, isDirty, isNew, isOpen, isReadOnly, markDirty, notifyObservers, refreshTimestamp, setOpen, setTimestampDirectly, setURLDirectly
 
Methods inherited from class oracle.ide.model.DefaultElement
getAttributes, getData
 
Methods inherited from class oracle.ide.model.DefaultDisplayable
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.ide.model.Document
getInputStream, getTimestamp, isNew, isReadOnly, open, save
 
Methods inherited from interface oracle.ide.model.Locatable
getURL, setURL
 
Methods inherited from interface oracle.ide.model.Element
getAttributes
 
Methods inherited from interface oracle.ide.model.Data
getData
 
Methods inherited from interface oracle.ide.model.Displayable
toString
 
Methods inherited from interface oracle.ide.addin.Subject
attach, detach, notifyObservers
 
Methods inherited from interface oracle.ide.model.Dirtyable
isDirty, markDirty
 
Methods inherited from interface oracle.ide.model.LazyLoadable
isOpen
 
Methods inherited from interface oracle.ide.model.Category
getCategory
 

Field Detail

BASENAME

public static final java.lang.String BASENAME
The base filename of the file where the contents of the top-level 'Miscellaneous Files' folder are stored.

See Also:
Constant Field Values

EXT

public static final java.lang.String EXT
The file extension of the file where the contents of the top-level 'Miscellaneous Files' folder are stored.

See Also:
Constant Field Values

NAMESPACE_URI

public static final java.lang.String NAMESPACE_URI
The namespace URI.


ROOT_TAG

public static final java.lang.String ROOT_TAG
The XML root tag name.

See Also:
Constant Field Values
Constructor Detail

MiscellaneousFolder

public MiscellaneousFolder()
Default constructor, used for beans instantiation.

Method Detail

checkAddToSystem

public void checkAddToSystem()

checkRemoveFromSystem

public void checkRemoveFromSystem()

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
Overrides:
getShortLabel in class DefaultDocument
See Also:
Displayable.getShortLabel()

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
Overrides:
getLongLabel in class DefaultDocument
See Also:
Displayable.getLongLabel()

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
Overrides:
getToolTipText in class DefaultDocument
See Also:
Displayable.getToolTipText()

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
Overrides:
getIcon in class DefaultDisplayable
See Also:
Displayable.getIcon()

remove

public boolean remove(Element element)
Description copied from class: DataContainer
Part of the Folder interface. The specified Element is removed from the child list. However, if the Element is null, this method does nothing. If the Element occurs more than once in the child list, then only the first instance is removed.

No notification is fired by this method.

Specified by:
remove in interface Folder
Overrides:
remove in class DataContainer
See Also:
Folder.remove(Element)

canAdd

public boolean canAdd(Element element)
Description copied from class: DataContainer
Part of the Folder interface. The default implementation returns true if and only if the specified Element is not null.

Specified by:
canAdd in interface Folder
Overrides:
canAdd in class DataContainer
Returns:
true if and only if the specified Element is not null.
See Also:
Folder.canAdd(Element)

close

public void close()
Description copied from interface: Document
Closes the Document and unloads any associated data. When this method returns, the state of the Document object should be equivalent to when the Document object has just been instantiated but not yet opened.

Specified by:
close in interface Document
Overrides:
close in class DataContainer

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.