sk.uniba.euromath.editor.xmlEditor.actions
Class NodeManipulateAction

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.jface.action.AbstractAction
          org.eclipse.jface.action.Action
              org.eclipse.gef.ui.actions.WorkbenchPartAction
                  sk.uniba.euromath.editor.xmlEditor.actions.XMLAccessModifyAction
                      sk.uniba.euromath.editor.xmlEditor.actions.NodeManipulateAction

All Implemented Interfaces:

org.eclipse.gef.Disposable, org.eclipse.gef.ui.actions.UpdateAction, IAction

Direct Known Subclasses:

AddAttributeWizardAction, DecloseElementAction, EncloseElementAction, InsertAction, ModifyNodeAction, SelectParentAction

public abstract class NodeManipulateAction
extends XMLAccessModifyAction

Common action for manipulating single node gained from:

• selection
• contructor - if node was specified in constructor, that node is taken into account, so selection is not handled.

How node is gained from selection, is specified by type:

• NodeManipulateAction#SINGLE - selection must contain one node only (otherwise action is disabled), so which is taken for manipulation
• NodeManipulateAction#FIRST - as node for manipualtion is taken first node in selection
• NodeManipulateAction#LAST - as node for manipualtion is taken last node in selection

and into account is taken way of partially selected nodes processing (this option is set in constructor):

• if selection contains some partially selected nodes, then action is disabled
• if selection contains some partially selected nodes, they are proccessed as completelly selected nodes

Nested Class Summary

static class

NodeManipulateAction.NodeAcquireType Ways of how node for manipulation is acquired.

Field Summary

Fields inherited from class sk.uniba.euromath.editor.xmlEditor.actions.XMLAccessModifyAction

selection

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

NodeManipulateAction(IWorkbenchPart part)
Constructor.

NodeManipulateAction(IWorkbenchPart part, NodeManipulateAction.NodeAcquireType type, boolean wholeNodesOnly)
Constructor.

NodeManipulateAction(Node node, IWorkbenchPart part)
Constructor.

Method Summary

protected boolean	calculateEnabled() Is enabled if and only if node is not null (includes also case of wholeNodesOnly condition violation).
Node	getNode() Returns node to manipulate with, which can be node from constructor or node processed from selection.
NodeManipulateAction.NodeAcquireType	getType() Getter for type how node for manipulation is gained.
protected boolean	isStatic() True, if node to manipulate was gained from contructor - was statically gained.
protected void	processSelection() Processes selection, if should manipulate with node from selection.
void	setType(NodeManipulateAction.NodeAcquireType type) Setter for type how node for manipulation is gained.

Methods inherited from class sk.uniba.euromath.editor.xmlEditor.actions.XMLAccessModifyAction

dispose, getCaretManager, getIdManager, getModifyHelper, getPointer, getSelection, getSelectionProvider, getShell, getXMLAccess, handleDocumentException, handleExportException, logError, logError, run, runAsCommand, setWorkbenchPart

Methods inherited from class org.eclipse.gef.ui.actions.WorkbenchPartAction

execute, getCommandStack, getWorkbenchPart, init, isEnabled, refresh, setLazyEnablementCalculation, update

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, 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

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

addPropertyChangeListener, removePropertyChangeListener

Constructor Detail

NodeManipulateAction

public NodeManipulateAction(IWorkbenchPart part)

Constructor. Creates action manipulating with node from selection. Type must be later specified.

Parameters:

part - associated workbench part

NodeManipulateAction

public NodeManipulateAction(IWorkbenchPart part,
                            NodeManipulateAction.NodeAcquireType type,
                            boolean wholeNodesOnly)

Constructor. Creates action manipulating with node from selection.

Parameters:

part - associated workbench part

type - one of NodeManipulateAction.NodeAcquireType.First, NodeManipulateAction.NodeAcquireType.Last, NodeManipulateAction.NodeAcquireType.Single

wholeNodesOnly - !!! NOT IMPLEMENTED YET TODO STUDVA If to work and be enabled only when selection contains nodes, which are wholly selected

• true - if selection contains some partially selected nodes, then action is disabled
• false - if selection contains some partially selected nodes, they are proccessed as completelly selected nodes

NodeManipulateAction

public NodeManipulateAction(Node node,
                            IWorkbenchPart part)

Constructor. Creates action manipulating with node node.

Parameters:

node - node to manipulate, must not be null

part - associated workbench part

Method Detail

calculateEnabled

protected boolean calculateEnabled()

Is enabled if and only if node is not null (includes also case of wholeNodesOnly condition violation).

Overrides:

calculateEnabled in class XMLAccessModifyAction

getNode

public Node getNode()

Returns node to manipulate with, which can be node from constructor or node processed from selection.

Returns:

node to manipulate or nullif action is disabled

processSelection

protected void processSelection()

Processes selection, if should manipulate with node from selection. Calculates node to manipulate from selection.

Overrides:

processSelection in class XMLAccessModifyAction

isStatic

protected boolean isStatic()

True, if node to manipulate was gained from contructor - was statically gained.

getType

public NodeManipulateAction.NodeAcquireType getType()

Getter for type how node for manipulation is gained.

setType

public void setType(NodeManipulateAction.NodeAcquireType type)

Setter for type how node for manipulation is gained. One of NodeManipulateAction.NodeAcquireType.First, NodeManipulateAction.NodeAcquireType.Last, NodeManipulateAction.NodeAcquireType.Single. NodeManipulateAction.NodeAcquireType.Static is not allowed, use instead contructor.