|
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.Preferences
This a new class that is under development to replace Preferences.
Field Summary | |
static java.lang.String |
DEFAULT_PROJECT_KEY |
static java.lang.String |
DEFAULT_WORKSPACE_KEY |
Fields inherited from class oracle.ide.model.DefaultFolder |
_children |
Constructor Summary | |
Preferences() Default constructor. |
|
Preferences(Preferences preferences) Copy constructor. |
Method Summary | |
java.lang.Object |
copyTo(java.lang.Object object) Copies the internal state of this object to the specified copy . |
java.util.Iterator |
getChildren() Part of the Element interface. |
Project |
getDefaultProject() Returns the default project. |
Workspace |
getDefaultWorkspace() Returns the default workspace. |
javax.swing.Icon |
getIcon() Part of Element interface. |
java.lang.String |
getLongLabel() Returns a long label that can be displayed to the user. |
java.util.Map |
getPreferencesMap() |
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 |
isDefaultProject(Project project) |
boolean |
isDefaultWorkspace(Workspace workspace) |
boolean |
isDirty() True if the data in the object has been modified. |
void |
markDirty(boolean dirty) Marks the data with the specified dirty state. |
void |
setOwner(Dirtyable owner) This method should be called to set the document in which a SubDirtyable implementation will be persisted. |
void |
setPreferencesMap(java.util.Map preferencesMap) |
Methods inherited from class oracle.ide.model.DefaultFolder |
add, canAdd, canRemove, containsChild, copyToImpl, equalsImpl, mayHaveChildren, remove, removeAll, size |
Methods inherited from class oracle.ide.model.DefaultElement |
getAttributes, getData |
Methods inherited from class oracle.ide.model.DefaultDisplayable |
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 |
toString |
Field Detail |
public static final java.lang.String DEFAULT_PROJECT_KEY
public static final java.lang.String DEFAULT_WORKSPACE_KEY
Constructor Detail |
public Preferences()
public Preferences(Preferences preferences)
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
object
- The target object to which the state of this
object should be copied. If target
is null
, then the copyTo
method will return a new instance of this
class.this
object was copied. If the target
was non-null
, then the return value is the same as the target
object that was passed in; otherwise, the return value is a new instance of this
class.public java.util.Map getPreferencesMap()
public void setPreferencesMap(java.util.Map preferencesMap)
public boolean isDirty()
Dirtyable
isDirty
in interface Dirtyable
true
if the data in the object has been modified.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
dirty
- If true
, sets the object as being dirty; if false
, sets the object as being up-to-date.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 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 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 DefaultDisplayable
Displayable.getLongLabel()
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 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 DefaultDisplayable
Displayable.getToolTipText()
public java.util.Iterator getChildren()
DefaultFolder
Element
interface. This implementation returns an Iterator
over the current list of children.getChildren
in interface Element
getChildren
in class DefaultFolder
Element.getChildren()
public Project getDefaultProject()
null
.public boolean isDefaultProject(Project project)
public Workspace getDefaultWorkspace()
null
.public boolean isDefaultWorkspace(Workspace workspace)
|
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.