|
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.model.DefaultDisplayable
oracle.ide.model.DefaultElement
oracle.ide.model.DefaultFolder
oracle.ide.model.DataFolder
oracle.ide.model.ObservableDataFolder
oracle.ide.model.Workspaces
This a new class that is under development to replace Workspaces.
Field Summary | |
static java.lang.String |
WORKSPACES Constant identifying this object. |
Fields inherited from class oracle.ide.model.DefaultFolder |
_children |
Fields inherited from interface oracle.ide.addin.Subject |
OBJECT_MODIFIED |
Constructor Summary | |
Workspaces() Default constructor. |
|
Workspaces(Workspaces workspaces) Copy constructor. |
Method Summary | |
boolean |
canAdd(Element element) Folder interface method. |
java.lang.Object |
copyTo(java.lang.Object object) Copies the internal state of this object to the specified copy . |
protected void |
copyToImpl(Workspaces copy) Design pattern for supporting strongly typed copying. |
Workspace |
currentActiveWorkspace() Returns the currently active Workspace associated with this Workspaces . |
java.util.Map |
getActiveProjectMap() Gets a map containing information about what project for a given workspace. |
java.net.URL |
getActiveWorkspaceURL() |
javax.swing.Icon |
getIcon() Part of Element interface. |
java.lang.String |
getShortLabel() Returns a short label that can be displayed to the user. |
java.net.URL |
getWorkDirectory() |
boolean |
isDirty() True if the data in the object has been modified. |
void |
markDirty(boolean dirty) Marks the data with the specified dirty state. |
boolean |
remove(Element doc) Part of the Folder interface. |
void |
setActiveProjectMap(java.util.Map map) Sets the active project map. |
void |
setActiveWorkspace(Workspace workspace) Sets the currently active Workspace associated with this Workspaces . |
void |
setActiveWorkspaceURL(java.net.URL workspaceURL) |
void |
setListOfChildren(java.util.List list) Fulfills the public accessor part of the Folder contract. |
void |
setOwner(Dirtyable owner) This method should be called to set the document in which a SubDirtyable implementation will be persisted. |
void |
setWorkDirectory(java.net.URL workDirectory) Sets the default root directory for all new Workspace s. |
Methods inherited from class oracle.ide.model.ObservableDataFolder |
attach, detach, notifyObservers |
Methods inherited from class oracle.ide.model.DataFolder |
add, getListOfChildren, removeAll |
Methods inherited from class oracle.ide.model.DefaultFolder |
canRemove, containsChild, copyToImpl, equalsImpl, getChildren, mayHaveChildren, size |
Methods inherited from class oracle.ide.model.DefaultElement |
getAttributes, getData |
Methods inherited from class oracle.ide.model.DefaultDisplayable |
getLongLabel, getToolTipText, 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.Element |
getAttributes |
Methods inherited from interface oracle.ide.model.Data |
getData |
Methods inherited from interface oracle.ide.model.Displayable |
getLongLabel, getToolTipText, toString |
Field Detail |
public static final java.lang.String WORKSPACES
Constructor Detail |
public Workspaces()
public Workspaces(Workspaces workspaces)
Method Detail |
public java.lang.Object copyTo(java.lang.Object object)
Copyable
this
object to the specified copy
. If copy
is null
, then this method should create a new instance of this
class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.
Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this
object's state was copied.
There is a standard implementation pattern for the copyTo
method that helps avoid problems that arise when a Copyable
object is subclassed. The pattern is:
public Object copyTo( Object target )
{
final <this_class> copy =
target != null ? (<this_class>) target : new <this_class>();
copyToImpl( copy );
return copy;
} protected final void copyToImpl( <this_class> copy ) { super.copyToImpl( copy ); // if necessary // put code here for copying the properties of <this_class> }
The parameter passed into the copyToImpl
method is the same type of this
class. The responsibility of copyToImpl
is to copy the state of this
class through direct access of the fields. The copyToImpl
method should not use getters and setters since these may be overridden, causing the state of this
class to be incompletely copied.copyTo
in interface Copyable
copyTo
in class ObservableDataFolder
protected final void copyToImpl(Workspaces copy)
public java.net.URL getWorkDirectory()
Workspace
s.public void setWorkDirectory(java.net.URL workDirectory)
Workspace
s.public java.net.URL getActiveWorkspaceURL()
public void setActiveWorkspaceURL(java.net.URL workspaceURL)
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 DefaultDisplayable
Displayable.getShortLabel()
public javax.swing.Icon getIcon()
DefaultFolder
Element
interface. The default implementation returns null
, which causes a default folder icon to be used.getIcon
in interface Displayable
getIcon
in class DefaultFolder
Displayable.getIcon()
public boolean canAdd(Element element)
Folder
interface method. Returns true
if the type of the specified Element
exactly matches Workspace
. Returns false
otherwise.canAdd
in interface Folder
canAdd
in class DefaultFolder
true
if and only if the specified Element
is not null
.Folder.canAdd(Element)
, DefaultFolder.canAdd(Element)
, Workspace
public boolean remove(Element doc)
DefaultFolder
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.
In order for the UI to get updated correctly, an appropriate UpdateMessage
will need to be sent to Observer
s of the DefaultFolder
. The policy in the IDE is that the class that changes the state of an object is responsible for firing the UpdateMessage
s for those changes. UpdateMessage
s are not fired by the changed object itself.
For a single UpdateMessage
corresponding to DefaultFolder.remove(Element)
, you can fire the UpdateMessage
using code like:
UpdateMessage.fireChildRemoved(folder, removedChild);
remove
in interface Folder
remove
in class DataFolder
public void setListOfChildren(java.util.List list)
DataFolder
Folder
contract. Sets the child list of the DataFolder
instance to match the specified List
. Only objects in the List
that can be cast to Element
are added. The implementation uses the DefaultFolder.add(Element)
method to add the child to the list, so that subclass implementations can override DefaultFolder.add(Element)
without having to also override this method.setListOfChildren
in class DataFolder
public boolean isDirty()
Dirtyable
isDirty
in interface Dirtyable
isDirty
in class DataFolder
public void markDirty(boolean dirty)
Dirtyable
markDirty(...)
instead of setDirty(...)
so that the JavaBeans Introspector
will not mistakenly identify "dirty" as a JavaBean property.markDirty
in interface Dirtyable
markDirty
in class DataFolder
public void setOwner(Dirtyable owner)
SubDirtyable
SubDirtyable
implementation will be persisted.setOwner
in interface SubDirtyable
owner
- The Dirtyable
object in which this SubDirtyable
will be saved.public Workspace currentActiveWorkspace()
Workspace
associated with this Workspaces
. If there is no currently active Workspace
, null is returned This method is called currentActiveWorkspace
instead of getActiveWorkspace
in order to avoid having the "_activeWorkspace" property get picked up by the Introspector
.public void setActiveWorkspace(Workspace workspace)
Workspace
associated with this Workspaces
.public java.util.Map getActiveProjectMap()
public void setActiveProjectMap(java.util.Map map)
|
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.