Preferences.public class Preferences extends DefaultFolder implements Copyable, SubDirtyable
Preferences| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DEFAULT_PROJECT_KEY
Deprecated.
|
static java.lang.String |
DEFAULT_WORKSPACE_KEY
Deprecated.
|
_children| Constructor and Description |
|---|
Preferences()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
copyTo(java.lang.Object object)
Deprecated.
Copies the internal state of
this object to the specified copy. |
java.util.Iterator |
getChildren()
Deprecated.
Part of the
Element interface. |
Project |
getDefaultProject()
Deprecated.
Returns the default project.
|
Workspace |
getDefaultWorkspace()
Deprecated.
Returns the default workspace.
|
javax.swing.Icon |
getIcon()
Deprecated.
Part of
Element interface. |
java.lang.String |
getLongLabel()
Deprecated.
This implementation delegates to
DefaultDisplayable.getShortLabel(). |
java.util.Map |
getPreferencesMap()
Deprecated.
|
java.lang.String |
getShortLabel()
Deprecated.
This implementation returns a place-holder
String. |
java.lang.String |
getToolTipText()
Deprecated.
This implementation delegates to
DefaultDisplayable.getLongLabel(). |
boolean |
isDirty()
Deprecated.
True if the data in the object has been modified.
|
void |
markDirty(boolean dirty)
Deprecated.
Marks the data with the specified dirty state.
|
void |
setOwner(Dirtyable owner)
Deprecated.
This method should be called to set the document in which a
SubDirtyable implementation will be persisted. |
void |
setPreferencesMap(java.util.Map preferencesMap)
Deprecated.
|
add, canAdd, canRemove, containsChild, copyToImpl, equalsImpl, mayHaveChildren, remove, removeAll, sizegetAttributes, getDatatoStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetAttributes, getDatatoStringpublic static final java.lang.String DEFAULT_PROJECT_KEY
public static final java.lang.String DEFAULT_WORKSPACE_KEY
public java.lang.Object copyTo(java.lang.Object object)
Copyablethis 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 Copyableobject - 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()
Dirtyablepublic void markDirty(boolean dirty)
DirtyablemarkDirty(...) instead of setDirty(...) so that the JavaBeans Introspector will not mistakenly identify "dirty" as a JavaBean property.public void setOwner(Dirtyable owner)
SubDirtyableSubDirtyable implementation will be persisted.setOwner in interface SubDirtyableowner - The Dirtyable object in which this SubDirtyable will be saved.public java.lang.String getShortLabel()
DefaultDisplayableString.getShortLabel in interface DisplayablegetShortLabel in class DefaultDisplayableDisplayable that can be shown to the user.Displayable.getShortLabel()public java.lang.String getLongLabel()
DefaultDisplayableDefaultDisplayable.getShortLabel().getLongLabel in interface DisplayablegetLongLabel in class DefaultDisplayableDisplayable that can be shown to the user.Displayable.getLongLabel()public javax.swing.Icon getIcon()
DefaultFolderElement interface. The default implementation returns null, which causes a default folder icon to be used.getIcon in interface DisplayablegetIcon in class DefaultFolderIcon to be displayed for the Displayable.Displayable.getIcon()public java.lang.String getToolTipText()
DefaultDisplayableDefaultDisplayable.getLongLabel().getToolTipText in interface DisplayablegetToolTipText in class DefaultDisplayableDisplayable.Displayable.getToolTipText()public java.util.Iterator getChildren()
DefaultFolderElement interface. This implementation returns an Iterator over the current list of children.getChildren in interface ElementgetChildren in class DefaultFolderIterator over any child Elements contained by this Element. If there are no children, null is returned.Element.getChildren()public Project getDefaultProject()
null.public Workspace getDefaultWorkspace()
null.