|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-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.model.XMLDataNode
oracle.ide.model.XMLDataContainer
public class XMLDataContainer
The XMLDataContainer is the Node wrapper for a Folder-implementing JavaBean that can be persisted to XML using the XML marshalling framework in oracle.ide.marshal.xml.
XMLDataContainer wraps objects that can contain children. In order to interact with XMLDataContainer, wrapped objects must implement Folder.
All methods to the XMLDataContainer's Element and Folder methods are forwarded to the wrapped Folder object.
If the wrapped object is not an instance of Folder, then an IllegalStateException will be thrown every time an operation that requires the children list is called.
Object2Dom| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class oracle.ide.model.XMLDataNode |
|---|
XMLDataNode.DataCastPacket |
| Field Summary |
|---|
| Fields inherited from class oracle.ide.model.Node |
|---|
LOG_READONLY |
| Constructor Summary | |
|---|---|
XMLDataContainer() |
|
| Method Summary | |
|---|---|
boolean |
add(Element element)Appends a child Element to the end of the Folder. |
boolean |
add(Element element, boolean notify) |
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. |
protected Folder |
getDataFolder()Retrieves the Folder object associated with this XMLDataContainer instance. |
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)Removes the specified child Element. |
boolean |
remove(Element element, boolean notify) |
void |
removeAll()Removes all children from the folder. |
void |
removeAll(boolean notify) |
int |
size()Returns the current number of children in the folder. |
| Methods inherited from class oracle.ide.model.XMLDataNode |
|---|
closeImpl, getAttributes, getChildren, getData, getDataCastPacketDirectly, getDefaultClass, getIcon, getToolTipText, getXMLRootElementName, markDirty, newObject2Dom, openImpl, saveImpl, setData, setDataCastPacketDirectly, setNodeInfo, setURL |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface oracle.ide.model.Element |
|---|
getAttributes, getChildren, getData |
| Methods inherited from interface oracle.ide.model.Displayable |
|---|
getIcon, getLongLabel, getShortLabel, getToolTipText, toString |
| Constructor Detail |
|---|
public XMLDataContainer()
| Method Detail |
|---|
public boolean mayHaveChildren()
ElementElement 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 ElementmayHaveChildren in class XMLDataNodetrue if this Element may contain child Elements.public boolean canAdd(Element element)
FolderElement can be added to the Folder.canAdd in interface Folderelement - 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 add(Element element)
FolderElement to the end of the Folder.add in interface Folderpublic boolean canRemove(Element element)
FolderElement can be removed from this Folder.canRemove in interface Folderelement - 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 remove(Element element)
FolderElement. If the child object appears more than once, only the first instance is removed.remove in interface Folderelement - The child object to remove.public boolean containsChild(Element child)
Foldertrue if the folder contains the specified child Element; returns false otherwise.containsChild in interface Folderpublic int size()
Foldersize in interface Folderpublic void removeAll()
FolderremoveAll in interface Folder
public boolean add(Element element,
boolean notify)
public boolean remove(Element element,
boolean notify)
public void removeAll(boolean notify)
protected final Folder getDataFolder()
throws java.lang.IllegalStateException
Folder object associated with this XMLDataContainer instance. If there is no Folder currently associated with the XMLDataContainer, however, then an IllegalStateException is thrown.java.lang.IllegalStateException - if the XMLDataContainer is not capable of holding a Folder.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-01 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||