com.ibm.rational.common.test.editor.framework.kernel.actions

Class NewModelElementAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.jface.action.AbstractAction

org.eclipse.jface.action.Action

com.ibm.rational.common.test.editor.framework.kernel.actions.NewModelElementAction

All Implemented Interfaces:

IAction

public class NewModelElementAction
extends Action

NewModelElementAction is a class to be used to contribute actions to "Add" and "Insert" sub-menus in Test Editor. In most cases, it does not need to sub-classed, the only thing to do is declare a "newAction" element in the modelObjectDescriptor extension point.
It may need subclassing when:

• Several menu items correspond to creating the same model element
• Interaction with the user is required before creating the element

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD Deprecated.
protected List<com.ibm.rational.common.test.editor.framework.change.IAddChangeContext>	parentContexts

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT

Constructor Summary

Constructors

Constructor and Description
NewModelElementAction() Create an action for creating a specific model element type.
NewModelElementAction(String type) Create an action for model element type type.
NewModelElementAction(String type, boolean loadExtensions) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addChild(List<CBActionElement> children, CBActionElement child) Deprecated. This method is no longer called.
protected com.ibm.rational.common.test.editor.framework.change.AddChangeResult	addChildren(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context, List<CBActionElement> children) This implementation invokes the method IContainerActionHandler#addChildren(IAddChangeContext, com.ibm.rational.common.test.editor.framework.kernel.interfaces.IAddedElementDescriptor) on the action handler of the parent element.
protected boolean	areValidParents(List<CBActionElement> parents) Determines if the action allows adding one element under each of the specified parents.
void	cancelDropOperation() Cancels any drop operation announced through NewModelElementAction.startDropOperation(CBActionElement, ISelection).
protected com.ibm.rational.common.test.editor.framework.change.IEditorChange	createAddChange()
com.ibm.rational.common.test.editor.framework.change.IEditorChange	createAddChange(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context)
com.ibm.rational.common.test.editor.framework.change.IAddChangeContext	createAddChangeContext(CBActionElement parent)
protected CBActionElement	createChild(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context)
protected List<CBActionElement>	createChildren(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context) This method may create one or more children for the specified parent.
com.ibm.rational.common.test.editor.framework.change.IAddChangeContext	createInsertChangeContext(CBActionElement parent, int insertPoint, List<CBActionElement> selectedSiblings)
protected CBActionElement	createNewModelObject(CBActionElement parent) Deprecated. This method is not called any more.
protected CBActionElement	createNewModelObject(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context) Create a new instance of the model object.
com.ibm.rational.common.test.editor.framework.change.IAddChangeContext	createOtherChangeContext(CBActionElement parent, int insertPoint, List<CBActionElement> selectedElements)
protected CBActionElement	doCreate(CBActionElement parent) Deprecated. This method is not called any more. It is replaced partially by NewModelElementAction.createChild(IAddChangeContext) and partially by NewModelElementAction.addChildren(IAddChangeContext, List). NewModelElementAction.createNewModelObject(IAddChangeContext) may also be a replacement candidates as some protocols used to mistakenly override this method instead of NewModelElementAction.createNewModelObject(CBActionElement).
protected String	getCreatedElementType()
com.ibm.rational.common.test.editor.framework.kernel.interfaces.IActionHandler	getMyActionHandler()
List<CBActionElement>	getNewElements()
protected Object	getPostRunTarget(com.ibm.rational.common.test.editor.framework.change.AddChangeResult addResult) Returns the element that should be selected or given focus after the action completes.
TestEditor	getTestEditor()
protected void	init() Extracts text and image descriptor from ExtLabelProvider>/code>
boolean	isRefreshEnabled()
protected boolean	isValidParent(Object object) This method is called from updateSelection and is used to determine whether this action should be enabled or disabled.
protected void	refreshTest(CBActionElement parent, CBActionElement child)
protected void	refreshTest(CBActionElement parent, List<? extends CBActionElement> children)
void	run() Calls doCreate method, and refreshes the Test in the tree.
void	setContext(com.ibm.rational.common.test.editor.framework.internal.actions.EditorActionContext context)
void	setRefreshEnabled(boolean refreshEnabled)
void	setTestEditor(TestEditor editor)
void	showInsertionPoint() If the action is going to insert only one element, display the insertion point in the editor.
protected boolean	startDropOperation(CBActionElement target, ISelection droppedElements) Verifies if a specific drag and drop operation is allowed for the specified argument.

Methods inherited from class org.eclipse.jface.action.Action

convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class org.eclipse.jface.action.AbstractAction

addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Field Detail

ADD

@Deprecated
public static final int ADD

Deprecated.

constant indicating that this action adds, rather then inserts new elements

See Also:

Constant Field Values

parentContexts

protected final List<com.ibm.rational.common.test.editor.framework.change.IAddChangeContext> parentContexts

Constructor Detail

NewModelElementAction

public NewModelElementAction()

Create an action for creating a specific model element type. The type is derived from the declaring element in plugin.xml.

NewModelElementAction

public NewModelElementAction(String type)

Create an action for model element type type.

Parameters:

type - String Type of a CBActionElement object that this action produces.

NewModelElementAction

public NewModelElementAction(String type,
                     boolean loadExtensions)

Deprecated.

See Also:

NewExtensibleModelElementAction

Method Detail

init

protected void init()

Extracts text and image descriptor from ExtLabelProvider>/code>

createNewModelObject

protected CBActionElement createNewModelObject(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context)

Create a new instance of the model object. This implementation calls the associated action handler's IActionHandler.createNew(IAddChangeContext) method.

Parameters:

context - The context of the Add.

Returns:

The newly created child object.

createNewModelObject

protected final CBActionElement createNewModelObject(CBActionElement parent)

Deprecated. This method is not called any more.

Finds ExtActionHandler for its type and calls createnewObject method.

Parameters:

parent - CBActionElement. Object that is typically selected in the editor's tree.

Returns:

CBActionElement. Newly created child object.

See Also:

NewModelElementAction.createNewModelObject(IAddChangeContext)

startDropOperation

protected boolean startDropOperation(CBActionElement target,
                         ISelection droppedElements)

Verifies if a specific drag and drop operation is allowed for the specified argument. This method must be overridden if drop support is required. This operation is called only after regular checks (NewModelElementAction.isValidParent(Object), NewModelElementAction.areValidParents(List)) and only if these checks passed.
Note: the attribute "contributeDrop" must be explicitly set to true in plugin.xml to enable basic drag support; otherwise this method will not be called.

Parameters:

target - The target element of the drop operation (i.e. the parent element that should receive the dropped element). This parameter always correspond to the selection that was passed to #updateSelection(IStructuredSelection). If this method returns true, the framework will always call either NewModelElementAction.run() or NewModelElementAction.cancelDropOperation().

droppedElements - The elements being dropped.

cancelDropOperation

public void cancelDropOperation()

Cancels any drop operation announced through NewModelElementAction.startDropOperation(CBActionElement, ISelection). Any retained information about the drop operation must be released.

run

public void run()

Calls doCreate method, and refreshes the Test in the tree.

Specified by:

run in interface IAction

Overrides:

run in class Action

See Also:

IAction.run()

createAddChange

protected com.ibm.rational.common.test.editor.framework.change.IEditorChange createAddChange()

createAddChange

public com.ibm.rational.common.test.editor.framework.change.IEditorChange createAddChange(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context)

createChildren

protected List<CBActionElement> createChildren(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context)

This method may create one or more children for the specified parent. By default, this method creates only one child by calling NewModelElementAction.createChild(IAddChangeContext).

Parameters:

parent -

Returns:

createChild

protected CBActionElement createChild(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context)

doCreate

protected final CBActionElement doCreate(CBActionElement parent)

Deprecated. This method is not called any more. It is replaced partially by NewModelElementAction.createChild(IAddChangeContext) and partially by NewModelElementAction.addChildren(IAddChangeContext, List). NewModelElementAction.createNewModelObject(IAddChangeContext) may also be a replacement candidates as some protocols used to mistakenly override this method instead of NewModelElementAction.createNewModelObject(CBActionElement).

This method is called from run{} method. It does the following:

Finds ExtContentProvider for the parent and obtains its list of children, Calls createNewModelObject to create new child object, Adds new child object to the the list of parent's children (if the list is an instanceof EMF EList) Sets NEW status on the child object by calling ModelStateManager.setStatusNew(child, getTestEditor())

Parameters:

parent - CBActionElement selected in the tree

Returns:

CBActionElement new child object

See Also:

NewModelElementAction.createChild(IAddChangeContext), NewModelElementAction.addChildren(IAddChangeContext, List)

addChild

protected final void addChild(List<CBActionElement> children,
            CBActionElement child)

Deprecated. This method is no longer called.

Adds or inserts a new children into a list of children. If the list if an instaceof EList, the model change occures. Otherwise clients need to make sure the new child objects is indeed added to a model.

This method is called by doCreate only if the children obtained from parent's ExtContentProvider is of (sub-)type of EMF EList.

Parameters:

children - List of children

child -

See Also:

NewModelElementAction.addChildren(IAddChangeContext, List)

addChildren

protected com.ibm.rational.common.test.editor.framework.change.AddChangeResult addChildren(com.ibm.rational.common.test.editor.framework.change.IAddChangeContext context,
                                                                               List<CBActionElement> children)

This implementation invokes the method IContainerActionHandler#addChildren(IAddChangeContext, com.ibm.rational.common.test.editor.framework.kernel.interfaces.IAddedElementDescriptor) on the action handler of the parent element. Override if insertion of children in the parent list should be processed differently.

Parameters:

parent - The parent element

child - The child element to be added under the parent. This element has been been created by this action's NewModelElementAction.createNewModelObject(CBActionElement) method.

position - The position, within the list of children of the parent.

refreshTest

protected void refreshTest(CBActionElement parent,
               List<? extends CBActionElement> children)

refreshTest

protected void refreshTest(CBActionElement parent,
               CBActionElement child)

getTestEditor

public TestEditor getTestEditor()

isRefreshEnabled

public boolean isRefreshEnabled()

Returns:

Returns the refreshEnabled.

setRefreshEnabled

public void setRefreshEnabled(boolean refreshEnabled)

Parameters:

refreshEnabled - The refreshEnabled to set.

setContext

public final void setContext(com.ibm.rational.common.test.editor.framework.internal.actions.EditorActionContext context)

createAddChangeContext

public final com.ibm.rational.common.test.editor.framework.change.IAddChangeContext createAddChangeContext(CBActionElement parent)

createInsertChangeContext

public final com.ibm.rational.common.test.editor.framework.change.IAddChangeContext createInsertChangeContext(CBActionElement parent,
                                                                                               int insertPoint,
                                                                                               List<CBActionElement> selectedSiblings)

createOtherChangeContext

public final com.ibm.rational.common.test.editor.framework.change.IAddChangeContext createOtherChangeContext(CBActionElement parent,
                                                                                              int insertPoint,
                                                                                              List<CBActionElement> selectedElements)

getCreatedElementType

protected String getCreatedElementType()

isValidParent

protected boolean isValidParent(Object object)

This method is called from updateSelection and is used to determine whether this action should be enabled or disabled.

If client decides that the argument is one of the recognized types, suitable to have a child object of the type handled by this action, this method should return true. If the parent's type is not suitable or not recognized, the method should return false.

If isValidParent() returns false and extensions are loaded, the list of contributions is checked to see whether the parent/child relation was allowed declaratively (by updateSelection method). This implementation simply calls:

 CBActionElement element = (CBActionElement) object;
 return getTestEditor().getProviders(element).getActionHandler().isValidParent(element);
 

Parameters:

object -

Returns:

boolean

areValidParents

protected boolean areValidParents(List<CBActionElement> parents)

Determines if the action allows adding one element under each of the specified parents. This method is called only in ADD context (never in INSERT or DROP context), before NewModelElementAction.isValidParent(Object) is called on each element of the list.
The default implementation returns true. Subclasses may override to disable the action even if each individual parent is valid.

Parameters:

parents -

Returns:

setTestEditor

public void setTestEditor(TestEditor editor)

getNewElements

public List<CBActionElement> getNewElements()

Returns:

Returns the newElements.

getMyActionHandler

public com.ibm.rational.common.test.editor.framework.kernel.interfaces.IActionHandler getMyActionHandler()

getPostRunTarget

protected Object getPostRunTarget(com.ibm.rational.common.test.editor.framework.change.AddChangeResult addResult)

Returns the element that should be selected or given focus after the action completes. Returns null to do the default selection (i.e. select the added element(s)).

Parameters:

addResult -

Returns:

showInsertionPoint

public final void showInsertionPoint()

If the action is going to insert only one element, display the insertion point in the editor.