Extension SDK 10.1.2


oracle.ide.cmd
Class PropertySetCommand

java.lang.Object
  extended byoracle.ide.addin.AbstractCommand
      extended byoracle.ide.cmd.PropertySetCommand

All Implemented Interfaces:
Command

public abstract class PropertySetCommand
extends AbstractCommand

The PropetySetCommand class provides a skeleton implemention for applying a property set, handling the undoing of the property set and sending out all relevant notifications. Subclass implemenations are responsible for actually applying the value to the live object.


Field Summary
protected java.lang.Object origin
protected java.lang.String property
protected java.lang.Object[] targets

Fields inherited from class oracle.ide.addin.AbstractCommand
cmdId, context, name, type

Fields inherited from interface oracle.ide.addin.Command
CANCEL, EXECUTING, NO_CHANGE, NO_UNDO, NORMAL, OK

Constructor Summary
protected PropertySetCommand(java.lang.Object origin, java.lang.Object[] targets, java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue)
Constructor.
protected PropertySetCommand(java.lang.Object origin, java.lang.Object target, java.lang.String property, java.lang.Object oldValue, java.lang.Object newValue)
Constructor.

Method Summary
int doit()
Assign the new value to the object and send out proper notification.
protected abstract void setValue(java.lang.Object newValue)
Perform the actual property setting.
int undo()
Restores the object to its previous state.

Methods inherited from class oracle.ide.addin.AbstractCommand
getAffectedDocuments, getContext, getData, getId, getName, getType, setContext, setData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

origin

protected java.lang.Object origin

targets

protected java.lang.Object[] targets

property

protected java.lang.String property

Constructor Detail

PropertySetCommand

protected PropertySetCommand(java.lang.Object origin,
                             java.lang.Object target,
                             java.lang.String property,
                             java.lang.Object oldValue,
                             java.lang.Object newValue)
Constructor.
Parameters:
origin - Origin of the action to be used in UpdateMessage instance.
target - Object upon which the command should be performed.
property - the name of the property whose value is about to change.
oldValue - the current value of the property.
newValue - the new value to apply.

PropertySetCommand

protected PropertySetCommand(java.lang.Object origin,
                             java.lang.Object[] targets,
                             java.lang.String property,
                             java.lang.Object oldValue,
                             java.lang.Object newValue)
Constructor.
Parameters:
origin - Origin of the action to be used in UpdateMessage instance.
targets - Objects upon which the command should be performed.
property - the name of the property whose value is about to change.
oldValue - the current value of the property.
newValue - the new value to apply.

Method Detail

setValue

protected abstract void setValue(java.lang.Object newValue)
                          throws java.lang.Exception
Perform the actual property setting.
Throws:
java.lang.Exception

doit

public int doit()
         throws java.lang.Exception
Assign the new value to the object and send out proper notification.
Throws:
java.lang.Exception

undo

public int undo()
         throws java.lang.Exception
Restores the object to its previous state.
Specified by:
undo in interface Command
Overrides:
undo in class AbstractCommand
Throws:
java.lang.Exception

Extension SDK


Copyright © 1997, 2004, Oracle. All rights reserved.