|
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.config.IdeSettings
This classes stores the IDE settings.
If you want to implement configurable elements, the Environment options is a good place to start. The EnvironOptions class groups a set of options. It is built as a bean to allow persistence and provides assign() and clone() methods for easy duplication (the panel must edit a copy of the data). The EnvironOptionsPanel
edits an instance of EnvironOptions
. EnvironOptions.EnvironmentConfigUI class is registered by IdeSettings but in most cases, it will be registered in the Addin.initialize()
Singleton through Ide - 1:1 - IdeSettings
Field Summary | |
static java.lang.String |
DATA_KEY |
static java.lang.String |
FILENAME |
static java.lang.String |
NAMESPACE_URI |
static java.lang.String |
ROOT_TAG |
Constructor Summary | |
IdeSettings() |
|
IdeSettings(IdeSettings ideSettings) Copy constructor. |
Method Summary | |
java.lang.Object |
copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy . |
protected void |
copyToImpl(IdeSettings copy) |
static void |
deregisterUI(Navigable ui) |
boolean |
equals(java.lang.Object o) |
protected boolean |
equalsImpl(IdeSettings opt) This is a helper method for equals(Object) that can also be used by subclasses that implement equals(Object) . |
java.lang.Object |
getData(java.lang.String dataKey) |
Navigable |
getEnvironNavigable() |
KeyStrokeOptions |
getKeyStrokeOptions() Convenience method for getting at one of the built in options. |
static Navigable[] |
getNavigables() |
void |
init() |
boolean |
load() Loads the registered data from the XML file. |
void |
putData(java.lang.String dataKey, Copyable data) |
void |
register() |
static void |
registerUI(Navigable ui) |
boolean |
save() Saves the registered data to the XML file. |
void |
showDialog(java.awt.Frame parent) Shows the configuration dialog. |
void |
showDialog(java.awt.Frame parent, MDDPanel panel, java.lang.String[] selectionPath) Shows the configuration dialog. |
void |
showDialog(java.awt.Frame parent, java.lang.String[] selectionPath) Shows the configuration dialog. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String FILENAME
public static final java.lang.String DATA_KEY
public static final java.lang.String NAMESPACE_URI
public static final java.lang.String ROOT_TAG
Constructor Detail |
public IdeSettings()
public IdeSettings(IdeSettings ideSettings)
Method Detail |
public void register()
public void init()
public java.lang.Object copyTo(java.lang.Object target)
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
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.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.protected final void copyToImpl(IdeSettings copy)
public static void registerUI(Navigable ui)
public static void deregisterUI(Navigable ui)
public static Navigable[] getNavigables()
public java.lang.Object getData(java.lang.String dataKey)
public void putData(java.lang.String dataKey, Copyable data)
public KeyStrokeOptions getKeyStrokeOptions()
public boolean save()
public boolean load()
public void showDialog(java.awt.Frame parent)
public void showDialog(java.awt.Frame parent, java.lang.String[] selectionPath)
public void showDialog(java.awt.Frame parent, MDDPanel panel, java.lang.String[] selectionPath)
public boolean equals(java.lang.Object o)
protected final boolean equalsImpl(IdeSettings opt)
equals(Object)
that can also be used by subclasses that implement equals(Object)
. It assumes that the argument is not null
.public Navigable getEnvironNavigable()
|
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.