oracle.ide.model
Class Preferences
java.lang.Object
|
+--oracle.ide.model.DefaultDisplayable
|
+--oracle.ide.model.DefaultElement
|
+--oracle.ide.model.DefaultFolder
|
+--oracle.ide.model.Preferences
- All Implemented Interfaces:
- Copyable, Data, Dirtyable, Displayable, Element, Folder, SubDirtyable
- public class Preferences
- extends DefaultFolder
- implements Copyable, SubDirtyable
This a new class that is under development to replace Preferences.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.ide.model.Data |
getData |
DEFAULT_PROJECT_KEY
public static final java.lang.String DEFAULT_PROJECT_KEY
DEFAULT_WORKSPACE_KEY
public static final java.lang.String DEFAULT_WORKSPACE_KEY
Preferences
public Preferences()
- Default constructor. Required for JavaBean status.
Preferences
public Preferences(Preferences preferences)
- Copy constructor.
copyTo
public java.lang.Object copyTo(java.lang.Object object)
- Description copied from interface:
Copyable
- Copies the internal state of
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.
- Specified by:
copyTo
in interface Copyable
- Following copied from interface:
oracle.ide.util.Copyable
- Parameters:
target
- 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.- Returns:
- The object to which the state of
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. - Throws:
java.lang.ClassCastException
- if target
is
non-null
and cannot be downcast to the type of
this
object.
getPreferencesMap
public java.util.Map getPreferencesMap()
setPreferencesMap
public void setPreferencesMap(java.util.Map preferencesMap)
isDirty
public boolean isDirty()
- Description copied from interface:
Dirtyable
- True if the data in the object has been modified.
- Specified by:
isDirty
in interface Dirtyable
- Following copied from interface:
oracle.ide.model.Dirtyable
- Returns:
true
if the data in the object has been modified.
markDirty
public void markDirty(boolean dirty)
- Description copied from interface:
Dirtyable
- Marks the data with the specified dirty state. This
method is called
markDirty(...)
instead of
setDirty(...)
so that the JavaBeans
Introspector
will not
mistakenly identify "dirty" as a JavaBean property.
- Specified by:
markDirty
in interface Dirtyable
- Following copied from interface:
oracle.ide.model.Dirtyable
- Parameters:
dirty
- If true
, sets the object as being
dirty; if false
, sets the object as being up-to-date.
setOwner
public void setOwner(Dirtyable owner)
- Description copied from interface:
SubDirtyable
- This method should be called to set the document in which a
SubDirtyable
implementation will be persisted.
- Specified by:
setOwner
in interface SubDirtyable
- Following copied from interface:
oracle.ide.model.SubDirtyable
- Parameters:
owner
- The Dirtyable
object in which this
SubDirtyable
will be saved.
getShortLabel
public java.lang.String getShortLabel()
- Description copied from interface:
Displayable
- Returns a short label that can be displayed to the user.
Generally, the value of the returned
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
.
- Overrides:
getShortLabel
in class DefaultDisplayable
- Following copied from interface:
oracle.ide.model.Displayable
- Returns:
- a short descriptive label of the
Displayable
that can be shown to the user.
getLongLabel
public java.lang.String getLongLabel()
- Description copied from interface:
Displayable
- Returns a long label that can be displayed to the user. Generally,
the value of the returned
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.
- Overrides:
getLongLabel
in class DefaultDisplayable
- Following copied from interface:
oracle.ide.model.Displayable
- Returns:
- a long descriptive label of the
Displayable
that
can be shown to the user.
getIcon
public javax.swing.Icon getIcon()
- Description copied from class:
DefaultFolder
- Part of
Element
interface. The default implementation
returns null
, which causes a default folder icon to be
used.
- Overrides:
getIcon
in class DefaultFolder
- Following copied from class:
oracle.ide.model.DefaultFolder
- See Also:
Displayable.getIcon()
getToolTipText
public java.lang.String getToolTipText()
- Description copied from interface:
Displayable
- Returns the tool tip text to show when the mouse pointer pauses
over a UI component that represents this
Displayable
.
In many cases it may be appropriate for this method to return the
same value as Displayable.getLongLabel()
.
- Overrides:
getToolTipText
in class DefaultDisplayable
- Following copied from interface:
oracle.ide.model.Displayable
- Returns:
- the tooltip to show when the mouse pointer pauses over a
UI component that represents this
Displayable
.
getChildren
public java.util.Iterator getChildren()
- Description copied from class:
DefaultFolder
- Part of the
Element
interface. This implementation returns
an Iterator
over the current list of children.
- Overrides:
getChildren
in class DefaultFolder
- Following copied from class:
oracle.ide.model.DefaultFolder
- See Also:
Element.getChildren()
getDefaultProject
public Project getDefaultProject()
- Returns the default project. If no default is
available, this returns
null
.
isDefaultProject
public boolean isDefaultProject(Project project)
getDefaultWorkspace
public Workspace getDefaultWorkspace()
- Returns the default workspace. If no default is
available, this returns
null
.
isDefaultWorkspace
public boolean isDefaultWorkspace(Workspace workspace)