|
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.layout.BaseLayout
oracle.ide.layout.IdeLayout
IdeLayout class. IdeLayout instances are layouts that can contain other layouts. For example, the design and debug layouts can contain other user created SimpleLayout
s as their children.
Field Summary |
Fields inherited from class oracle.ide.layout.BaseLayout |
_attributes, _lastModified, _url |
Fields inherited from interface oracle.ide.addin.Subject |
OBJECT_MODIFIED |
Fields inherited from interface oracle.ide.layout.Layout |
LAYOUT_ACTIVE_PROPERTY, LAYOUT_NAME_PROPERTY |
Constructor Summary | |
protected |
IdeLayout() |
IdeLayout(java.net.URL fileURL, java.lang.String shortLabel, ArrayResourceBundle iconBundle, int iconKey) |
|
IdeLayout(java.net.URL fileURL, java.lang.String shortLabel, javax.swing.Icon icon) |
Method Summary | |
boolean |
add(Element element) Appends a child Element to the end of the Folder . |
void |
attach(Observer observer) 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 . |
void |
close() Release the data associated with this item |
boolean |
containsChild(Element child) Returns true if the folder contains the specified child Element ; returns false otherwise. |
void |
detach(Observer observer) Unregisters an observer that is not interested anymore in being notified when the internal state of the class implementing the Subject interface changes. |
boolean |
equals(java.lang.Object o) |
protected boolean |
equalsImpl(IdeLayout other) |
Layout |
findLayout(java.net.URL url) Find the layout associated with the specified url . |
Layout |
getActiveLayout() |
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. |
Layout |
getDefaults() |
javax.swing.Icon |
getIcon() Returns an Icon that can be shown in association with this Displayable . |
java.io.InputStream |
getInputStream() Gets a InputStream that can be used to read the contents of this object. |
protected java.util.Map |
getLayoutMap() |
java.lang.String |
getLongLabel() Returns a long label that can be displayed to the user. |
java.lang.String |
getProperty(java.lang.String key, java.lang.String defaultValue) Retrieves the value associated with a property. |
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 |
isOpen() True if the data item has been loaded already. |
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 object, UpdateMessage change) Notifies all observers that the state of the subject has changed. |
void |
open() Open (load) the data associated with this item. |
boolean |
remove(Element element) Removes the specified child Element . |
void |
removeAll() Removes all children from the folder. |
java.lang.Object |
removeProperty(java.lang.String key) Removes the property. |
void |
save(boolean shallow) Force the node to be re-loaded from file. |
protected void |
setActiveLayout(Layout layout) |
java.lang.Object |
setProperty(java.lang.String key, java.lang.String value) Sets the value for a property. |
int |
size() Returns the current number of children in the folder. |
Methods inherited from class oracle.ide.layout.BaseLayout |
copyToImpl, equalsImpl, findLayout, getAttributes, getData, getFilename, getName, getOwner, getTimestamp, getURL, isActive, isDirty, isNew, isReadOnly, markDirty, setActive, setInherited, setOwner, setURL, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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 |
Constructor Detail |
public IdeLayout(java.net.URL fileURL, java.lang.String shortLabel, javax.swing.Icon icon)
public IdeLayout(java.net.URL fileURL, java.lang.String shortLabel, ArrayResourceBundle iconBundle, int iconKey)
protected IdeLayout()
Method Detail |
public java.lang.String getProperty(java.lang.String key, java.lang.String defaultValue)
PropertyAccess
getProperty
in interface PropertyAccess
key
- the property key for which a value is desired.defaultValue
- the value to return if no value currently exists.public java.lang.Object setProperty(java.lang.String key, java.lang.String value)
PropertyAccess
setProperty
in interface PropertyAccess
key
- the property key to setvalue
- the string value to setpublic java.lang.Object removeProperty(java.lang.String key)
PropertyAccess
removeProperty
in interface PropertyAccess
key
- the property key to removepublic Layout getActiveLayout()
public Layout findLayout(java.net.URL url)
url
. If the url
matches the default layout url return it, otherwise, look in the list of children.public java.io.InputStream getInputStream() throws java.io.IOException
InputStream
that can be used to read the contents of this object.getInputStream
in interface Document
java.io.IOException
- if a security manager exists and its checkRead
method denies read access.public void open()
open
in interface Document
public void close()
close
in interface Document
close
in class BaseLayout
public void save(boolean shallow) throws java.io.IOException
save
in interface Document
shallow
- do not save children if container. TBDjava.io.IOException
- Signals that an I/O exception of some sort occurred.public boolean isOpen()
isOpen
in interface LazyLoadable
true
if the data item has already been opened.public Layout getDefaults()
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
getShortLabel
in class BaseLayout
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 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
getLongLabel
in class BaseLayout
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
getToolTipText
in class BaseLayout
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
mayHaveChildren
in class BaseLayout
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
getChildren
in class BaseLayout
public boolean add(Element element)
Folder
Element
to the end of the Folder
.add
in interface Folder
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 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 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 containsChild(Element child)
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 void removeAll()
Folder
removeAll
in interface Folder
public void attach(Observer observer)
Subject
Subject
interface changes. Implementors should do nothing when the same observer is added more than once.attach
in interface Subject
attach
in class BaseLayout
public void detach(Observer observer)
Subject
Subject
interface changes. Implementors should do nothing when the same observer is removed more than once.detach
in interface Subject
detach
in class BaseLayout
public void notifyObservers(java.lang.Object object, UpdateMessage change)
Subject
notifyObservers
in interface Subject
notifyObservers
in class BaseLayout
public boolean equals(java.lang.Object o)
protected final boolean equalsImpl(IdeLayout other)
protected void setActiveLayout(Layout layout)
protected java.util.Map getLayoutMap()
|
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.