oracle.ide.keyboard
Class KeyStrokeOptions

java.lang.Object
  oracle.ide.config.ChangeEventSource
      oracle.ide.keyboard.KeyStrokeOptions

All Implemented Interfaces:

Copyable

public final class KeyStrokeOptions

extends ChangeEventSource

implements Copyable

This class stores the KeyStrokeMap for one global context and multiple local contexts.

Field Summary

static java.lang.String

KEY_SETTINGS

Constructor Summary

KeyStrokeOptions()

Method Summary

void	addContext(KeyStrokeContext ksc) Adds a context to the known contexts
KeyStrokeOptions	cloneObject(boolean bDeepCopy) note: does not clone the listeners
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
KeyStrokeMap	getGlobalKeyMap()
KeyStrokeMap	getLocalKeyMap(KeyStrokeContext ksc) Returns the KeyStrokeMap corresponding to this context
java.util.HashMap	getLocalKeyMaps()
java.lang.String	getPresetName() Gets the current name of the set.
java.util.ArrayList	getRegisteredContexts()
boolean	isModifiedPreset() Returns true if the current set was modified
void	removeContext(KeyStrokeContext ksc)
void	setGlobalKeyMap(KeyStrokeMap ksm)
void	setKeyboardPanelEventDispatcher(java.awt.event.ActionListener actionListener)
void	setLocalKeyMaps(java.util.HashMap mapKsmLocal)
void	setModifiedPreset(boolean bModified) Sets the modified flag.
void	setPresetName(java.lang.String sName) Sets the preset name
void	setRegisteredContexts(java.util.ArrayList list)
void	solvePostponedMaps()

Methods inherited from class oracle.ide.config.ChangeEventSource

addChangeListener, fireChangeEvent, fireChangeEvent, removeChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_SETTINGS

public static final java.lang.String KEY_SETTINGS

Constructor Detail

KeyStrokeOptions

public KeyStrokeOptions()

Method Detail

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

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.

cloneObject

public KeyStrokeOptions cloneObject(boolean bDeepCopy)

note: does not clone the listeners

getPresetName

public java.lang.String getPresetName()

Gets the current name of the set. If it is a preset, it returns this name

setPresetName

public void setPresetName(java.lang.String sName)

Sets the preset name

isModifiedPreset

public boolean isModifiedPreset()

Returns true if the current set was modified

setModifiedPreset

public void setModifiedPreset(boolean bModified)

Sets the modified flag.

getLocalKeyMap

public KeyStrokeMap getLocalKeyMap(KeyStrokeContext ksc)

Returns the KeyStrokeMap corresponding to this context

addContext

public void addContext(KeyStrokeContext ksc)

Adds a context to the known contexts

solvePostponedMaps

public void solvePostponedMaps()

removeContext

public void removeContext(KeyStrokeContext ksc)

setKeyboardPanelEventDispatcher

public void setKeyboardPanelEventDispatcher(java.awt.event.ActionListener actionListener)
                                     throws TransientMarker

Throws:

TransientMarker

getGlobalKeyMap

public KeyStrokeMap getGlobalKeyMap()

setGlobalKeyMap

public void setGlobalKeyMap(KeyStrokeMap ksm)

setLocalKeyMaps

public void setLocalKeyMaps(java.util.HashMap mapKsmLocal)

getLocalKeyMaps

public java.util.HashMap getLocalKeyMaps()

getRegisteredContexts

public java.util.ArrayList getRegisteredContexts()

setRegisteredContexts

public void setRegisteredContexts(java.util.ArrayList list)