Extension SDK 10.1.2

oracle.ide.model
Interface WorkEnvironment

All Superinterfaces:
Category, Container, Copyable, Data, Dirtyable, Displayable, Document, DynamicPropertySet, Element, Folder, LazyLoadable, Locatable, Node, Subject, VetoableSubject

public interface WorkEnvironment
extends Container, Copyable, VetoableSubject, DynamicPropertySet


Nested Class Summary
static interface WorkEnvironment.Setting
           
static interface WorkEnvironment.Settings
           
 
Field Summary
 
Fields inherited from interface oracle.ide.addin.Subject
OBJECT_MODIFIED
 
Fields inherited from interface oracle.ide.model.Category
UNDEFINED
 
Method Summary
 void add(java.util.Collection elements)
          Adds the collection of elements to the project.
 void add(java.util.Collection elements, Container ownerContainer)
          Adds the collection of Nodes to the project.
 boolean add(Node node, Container ownerContainer)
          Add the Node to the project.
 void addDependency(Dependable dependable)
          Adds a dependency to the project.
 boolean containsOwnedChild(Element child)
          Returns true if the child is contained by the project even if the owner is another folder contained in the project.
 Folder findOwner(Element element)
           
 WorkEnvironment.Setting getActiveSetting()
           
 java.util.Iterator getAllDependencies()
          Returns all dependables this project depends on.
 Container getContainerOwner(Element element)
          Get the container that owns the specified node.
 Container getContainerOwner(java.net.URL url)
          Get the container that owns the node associated with the specfied url.
 java.util.Iterator getDependencies()
          Returns dependables this project depends on.
 java.util.Iterator getMyChildren()
          Returns the children owned by this project.
 java.util.Iterator getOwnedChildren()
          Get a collection of children that are owned by other folders included in this project.
 WorkEnvironment.Settings getSettings()
           
 void removeDependency(Dependable dependable)
          Removes the specified element from the dependencies list.
 void removeOwnedChildren(Folder owner)
          Removes the children of the project that are owned by the specified owner.
 
Methods inherited from interface oracle.ide.model.Container
add, remove, removeAll
 
Methods inherited from interface oracle.ide.model.Document
close, 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, getChildren, mayHaveChildren
 
Methods inherited from interface oracle.ide.model.Data
getData
 
Methods inherited from interface oracle.ide.model.Displayable
getIcon, getLongLabel, getShortLabel, getToolTipText, 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
 
Methods inherited from interface oracle.ide.model.Folder
add, canAdd, canRemove, containsChild, remove, removeAll, size
 
Methods inherited from interface oracle.ide.util.Copyable
copyTo
 
Methods inherited from interface oracle.ide.addin.VetoableSubject
notifyObservers
 
Methods inherited from interface oracle.ide.util.DynamicPropertySet
getProperties, getProperty, getProperty, setProperties, setProperty
 

Method Detail

containsOwnedChild

public boolean containsOwnedChild(Element child)
Returns true if the child is contained by the project even if the owner is another folder contained in the project.


findOwner

public Folder findOwner(Element element)

add

public void add(java.util.Collection elements,
                Container ownerContainer)
Adds the collection of Nodes to the project. The nodes that could not be added to the project are removed from the collection. Call this method when adding nodes to the project that are owned by another folder. That is they are children of a folder contained also in the project. The items in the specified in the collection must be nodes. The ownerContainer must point to a Container The container owner is returned when the findOwner method is called.


add

public boolean add(Node node,
                   Container ownerContainer)
Add the Node to the project. Call this method when adding a node to the project that is owned by another folder. If the node is already contained by this project, this method returns without doing anything. The ownerContainer must point to a Container The container owner is returned when the findOwner method is called.


add

public void add(java.util.Collection elements)
Adds the collection of elements to the project. The elements that could not be added to the project are removed from the collection. The elements collection specified should not be null. This method adds the elements in the collection to the project without updating any other project property.


getMyChildren

public java.util.Iterator getMyChildren()
Returns the children owned by this project. This method excludes children that are owned by other folders contained in the project. To get all children of the project, including those owned by sub-folders, call the method getChildren.


getOwnedChildren

public java.util.Iterator getOwnedChildren()
Get a collection of children that are owned by other folders included in this project.


removeOwnedChildren

public void removeOwnedChildren(Folder owner)
Removes the children of the project that are owned by the specified owner. The owner need not be a direct child of this project. The method recursively removes children owned by other containers that may be children of the given owner. This method also notifies observers of the project that children were removed.


getContainerOwner

public Container getContainerOwner(java.net.URL url)
Get the container that owns the node associated with the specfied url.


getContainerOwner

public Container getContainerOwner(Element element)
Get the container that owns the specified node.


addDependency

public void addDependency(Dependable dependable)
Adds a dependency to the project.


removeDependency

public void removeDependency(Dependable dependable)
Removes the specified element from the dependencies list.


getDependencies

public java.util.Iterator getDependencies()
Returns dependables this project depends on. Returns a copy of the internal dependency list.


getAllDependencies

public java.util.Iterator getAllDependencies()
Returns all dependables this project depends on. Recurses collecting dependables of dependables.


getSettings

public WorkEnvironment.Settings getSettings()

getActiveSetting

public WorkEnvironment.Setting getActiveSetting()

Extension SDK

 

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