|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.model.Node oracle.ide.layout.Layout oracle.ide.layout.IdeLayout
public final class 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.model.Node |
---|
LOG_READONLY |
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 . |
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 . |
protected void |
closeImpl()
Release the data associated with this item |
boolean |
containsChild(Element child)
Returns true if the folder contains the
specified child Element ; returns false
otherwise. |
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()
Displayable interface method. |
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()
Displayable interface method. |
java.lang.String |
getProperty(java.lang.String key,
java.lang.String defaultValue)
Retrieves the value associated with a property. |
java.lang.String |
getShortLabel()
Displayable interface method. |
java.lang.String |
getToolTipText()
Displayable interface method. |
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. |
protected void |
openImpl()
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. |
protected void |
saveImpl()
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.Layout |
---|
getMenuFilter, getName, getOwner, isActive, isTrackedInNodeCache, setActive, setMenuFilter, setOwner, 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, 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 set
public java.lang.Object removeProperty(java.lang.String key)
PropertyAccess
removeProperty
in interface PropertyAccess
key
- the property key to remove
public 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 class Node
java.io.IOException
- if a security manager exists and its
checkRead
method denies read access.protected void openImpl() throws java.io.IOException
openImpl
in class Node
java.io.IOException
- if an I/O error occurred while openingprotected void closeImpl() throws java.io.IOException
closeImpl
in class Node
java.io.IOException
- if an I/O error occurred while closingprotected void saveImpl() throws java.io.IOException
saveImpl
in class Node
shallow
- do not save children if container.
TBD
java.io.IOException
- if an I/O error occurred while savingpublic Layout getDefaults()
public java.lang.String getShortLabel()
Node
Displayable
interface method. The Node class returns
the file name part of the currently set URL
. If the
currently set URL
is null
, then this method
returns "<null>".
getShortLabel
in interface Displayable
getShortLabel
in class Layout
Displayable
that can be shown to the user.public javax.swing.Icon getIcon()
Node
Displayable
interface method. The Node class returns
a generic icon.
getIcon
in interface Displayable
getIcon
in class Node
Icon
to be displayed for the
Displayable
.public java.lang.String getLongLabel()
Node
Displayable
interface method. The Node class returns
the path name part of the currently set URL
. If the
currently set URL
is null
, then this method
returns "<null>".
getLongLabel
in interface Displayable
getLongLabel
in class Node
Displayable
that
can be shown to the user.public java.lang.String getToolTipText()
Node
Displayable
interface method. The Node class returns
returns the String form of the currently set URL
.
getToolTipText
in interface Displayable
getToolTipText
in class Node
Displayable
.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 Node
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
getChildren
in class Layout
Iterator
over any child Element
s
contained by this Element
. If there are no children,
null
is returned.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 boolean equals(java.lang.Object o)
equals
in class java.lang.Object
protected final boolean equalsImpl(IdeLayout other)
protected void setActiveLayout(Layout layout)
protected java.util.Map getLayoutMap()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |