oracle.ide.editor
Class EditorsOptions
java.lang.Object
|
+--oracle.ide.editor.EditorsOptions
- All Implemented Interfaces:
- Copyable
- public class EditorsOptions
- extends java.lang.Object
- implements Copyable
This class stores the editors auto synchronize option. An editor addin
that allows users to turn off that editor's ability to automatically
synchronize with ongoing changes to the data model should call
the addAutoSyncOption
method to provide the required UI.
Method Summary |
void |
addAutoSyncOption(java.lang.Class editorClass,
java.lang.String label,
javax.swing.Icon icon,
boolean defaultValue)
Calling this method adds an entry to the Editors panel in the
IDE Settings dialog. |
java.lang.Object |
copyTo(java.lang.Object target)
Copies the internal state of this object to the
specified copy . |
protected void |
copyToImpl(EditorsOptions copy)
|
boolean |
equals(java.lang.Object o)
|
protected boolean |
equalsImpl(EditorsOptions opts)
|
java.util.Map |
getEditorsData()
Returns data to be persisted in the settings.xml file. |
boolean |
isAutoSync(java.lang.Class editorClass)
|
void |
removeAutoSyncOption(java.lang.Class editorClass)
Calling this method removes the specified editor type from the
IDE Settings editor panel. |
void |
setAutoSync(java.lang.Class editorClass,
boolean sync)
|
void |
setEditorsData(java.util.Map map)
Initializes the editors options from the data in the settings.xml file. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
KEY_SETTINGS
public static final java.lang.String KEY_SETTINGS
EditorsOptions
public EditorsOptions()
addAutoSyncOption
public void addAutoSyncOption(java.lang.Class editorClass,
java.lang.String label,
javax.swing.Icon icon,
boolean defaultValue)
- Calling this method adds an entry to the Editors panel in the
IDE Settings dialog.
removeAutoSyncOption
public void removeAutoSyncOption(java.lang.Class editorClass)
- Calling this method removes the specified editor type from the
IDE Settings editor panel.
setAutoSync
public void setAutoSync(java.lang.Class editorClass,
boolean sync)
isAutoSync
public boolean isAutoSync(java.lang.Class editorClass)
copyTo
public java.lang.Object copyTo(java.lang.Object target)
- 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.
copyToImpl
protected final void copyToImpl(EditorsOptions copy)
getEditorsData
public java.util.Map getEditorsData()
- Returns data to be persisted in the settings.xml file.
setEditorsData
public void setEditorsData(java.util.Map map)
- Initializes the editors options from the data in the settings.xml file.
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in class java.lang.Object
equalsImpl
protected final boolean equalsImpl(EditorsOptions opts)