Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com
Answertopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Runtime

org.eclipse.gmf.runtime.emf.ui.properties.commands
Class SetModelPropertyValueCommand

java.lang.Object
  extended by 

org.eclipse.core.commands.operations.AbstractOperation
      extended by org.eclipse.emf.workspace.AbstractEMFOperation
          extended by 

org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand
              extended by 
org.eclipse.gmf.runtime.emf.ui.properties.commands.SetModelPropertyValueCommand
All Implemented Interfaces:
IUndoableOperation, ICommand, org.eclipse.gmf.runtime.common.core.internal.command.ICommandWithSettableResult

public class SetModelPropertyValueCommand
extends AbstractTransactionalCommand

Command to set a property value in the model in an undo interval. Delegates the actual work of setting the property value to a SetPropertyValueCommand.


Constructor Summary
SetModelPropertyValueCommand (org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, java.lang.String label, java.lang.Object affectedObjects, IPropertySource propertySource, java.lang.Object propertyId, java.lang.Object propertyValue)
          Constructs a new command with the property source and the id of the property to be reset.
 
Method Summary
protected   CommandResult doExecuteWithResult ( IProgressMonitor progressMonitor, IAdaptable info)
          Implemented by subclasses to perform the model changes.
protected   CommandResult doRedoWithResult ( IProgressMonitor progressMonitor, IAdaptable info)
           
protected   CommandResult doUndoWithResult ( IProgressMonitor progressMonitor, IAdaptable info)
           
protected  java.lang.Object getPropertyId ()
          Gets the ID of the property whose default value is to be restored.
protected   IPropertySource getPropertySource ()
          Gets the property source that owns the property to be restored to its default value.
protected  java.lang.Object getPropertyValue ()
          Gets the property value that is set by this command.
protected  java.lang.Object getUndoValue ()
          Gets the property value which is used when this command execution is undone.
protected  boolean isValueResetOnUndo ()
          Gets the flag to indicate that the property value had never before been set, so a reset is appropriate when the command is undone.
protected  void setUndoValue (java.lang.Object object)
          Sets the property value which is used when this command execution is undone.
protected  void setValueResetOnUndo (boolean b)
          Sets the flag to indicate that the property value had never before been set, so a reset is appropriate when the command is undone.
 
Methods inherited from class org.eclipse.gmf.runtime.emf.commands.core.command. AbstractTransactionalCommand
aggregateStatuses, cleanup, compose, didRedo, didUndo, doExecute, doRedo, doUndo, getAffectedFiles, getCommandResult, getWorkspaceFiles, getWorkspaceFiles, internalSetResult, reduce, setResult
 
Methods inherited from class org.eclipse.emf.workspace.AbstractEMFOperation
canRedo, canSetOptions, canUndo, didCommit, dispose, execute, getChange, getEditingDomain, getOptions, isReuseParentTransaction, redo, setOptions, setReuseParentTransaction, undo
 
Methods inherited from class org.eclipse.core.commands.operations. AbstractOperation
addContext, canExecute, getContexts, getLabel, hasContext, removeContext, setLabel, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.gmf.runtime.common.core.command. ICommand
setLabel
 
Methods inherited from interface org.eclipse.core.commands.operations. IUndoableOperation
addContext, canExecute, canRedo, canUndo, dispose, execute, getContexts, getLabel, hasContext, redo, removeContext, undo
 

Constructor Detail

SetModelPropertyValueCommand

public SetModelPropertyValueCommand(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                    java.lang.String label,
                                    java.lang.Object affectedObjects,
                                    
IPropertySource propertySource,
                                    java.lang.Object propertyId,
                                    java.lang.Object propertyValue)
Constructs a new command with the property source and the id of the property to be reset.

Parameters:
editingDomain - the editing domain in which to make this change
label - The label for the command. Appears in the Edit menu items.
affectedObjects - The model operation context for the new model command.
propertySource - The property source that owns the property whose value is to be reset.
propertyId - The ID of the property to be reset.
propertyValue - The new property value which will be set by this command.
Method Detail

doExecuteWithResult

protected 
CommandResult doExecuteWithResult(
IProgressMonitor progressMonitor,
                                            
IAdaptable info)
                                     throws 
ExecutionException
Description copied from class: AbstractTransactionalCommand
Implemented by subclasses to perform the model changes. These changes are applied by manipulation of the EMF metamodel's API, not by executing commands on the editing domain's command stack.

Specified by:
doExecuteWithResult in class AbstractTransactionalCommand
Parameters:
progressMonitor - the progress monitor provided by the operation history
info - the adaptable provided by the operation history
Returns:
the result of the execution
Throws:
ExecutionException - if, for some reason, I fail to complete the operation

doRedoWithResult

protected 
CommandResult doRedoWithResult(
IProgressMonitor progressMonitor,
                                         
IAdaptable info)
                                  throws 
ExecutionException
Throws:
ExecutionException

doUndoWithResult

protected 
CommandResult doUndoWithResult(
IProgressMonitor progressMonitor,
                                         
IAdaptable info)
                                  throws 
ExecutionException
Throws:
ExecutionException

isValueResetOnUndo

protected boolean isValueResetOnUndo()
Gets the flag to indicate that the property value had never before been set, so a reset is appropriate when the command is undone.

Returns:
true if undoing this command should reset the property value to its default, false otherwise.

setValueResetOnUndo

protected void setValueResetOnUndo(boolean b)
Sets the flag to indicate that the property value had never before been set, so a reset is appropriate when the command is undone.

Parameters:
b - true if undoing this command should reset the property value to its default, false otherwise.

getPropertySource

protected 
IPropertySource getPropertySource()
Gets the property source that owns the property to be restored to its default value.

Returns:
the property source

getPropertyId

protected java.lang.Object getPropertyId()
Gets the ID of the property whose default value is to be restored.

Returns:
the property ID

getUndoValue

protected java.lang.Object getUndoValue()
Gets the property value which is used when this command execution is undone.

Returns:
the undo property value

setUndoValue

protected void setUndoValue(java.lang.Object object)
Sets the property value which is used when this command execution is undone.

Parameters:
object - the undo property value

getPropertyValue

protected java.lang.Object getPropertyValue()
Gets the property value that is set by this command.

Returns:
the property value

Runtime

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire