Package com._1c.g5.v8.dt.ui.aef.actions

Class DtCommandActionBase

java.lang.Object

com._1c.g5.v8.dt.ui.aef.actions.DtCommandActionBase

All Implemented Interfaces:

IDtAction

Direct Known Subclasses:

AbstractDtModelEditingSupportAwareAction, DtCollapseAllAction, DtExpandAllAction

public abstract class DtCommandActionBase
extends Object
implements IDtAction

Base class for IHandler based actions.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FEATURE_VARIABLE	Feature IEvaluationContext variable name.
static String	MODEL_VARIABLE	Model IEvaluationContext variable name.

Constructor Summary

Constructors

Constructor	Description
DtCommandActionBase()

Method Summary

Modifier and Type	Method	Description
protected void	execute(String commandId, org.eclipse.core.commands.ExecutionEvent event)	Extecute command with the given id and the given execution event.
void	executeWith(org.eclipse.emf.ecore.EObject model, org.eclipse.emf.ecore.EStructuralFeature feature, ISelection selection)	Executes the action for a given model, model feature and selection.
protected abstract String	getCommandId()	Returns the command id to execute.
protected void	preExecute(org.eclipse.emf.ecore.EObject model, org.eclipse.emf.ecore.EStructuralFeature feature, ISelection selection, org.eclipse.core.expressions.IEvaluationContext context, Map<String,String> parameters)	Subclasses may override this method to specify custom pre-execution logic.
void	setContextIds(String... contextIds)	Deprecated. Put action to section with active context DtGranularEditorPageSingleColumnBuilder.section(java.lang.String)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com._1c.g5.v8.dt.ui.aef.actions.IDtAction

getIcon, getToolTip, isEnabledFor

Field Detail

MODEL_VARIABLE

public static final String MODEL_VARIABLE

Model IEvaluationContext variable name.

See Also:

Constant Field Values

FEATURE_VARIABLE

public static final String FEATURE_VARIABLE

Feature IEvaluationContext variable name.

See Also:

Constant Field Values

Constructor Detail

DtCommandActionBase

public DtCommandActionBase()

Method Detail

executeWith

public final void executeWith(org.eclipse.emf.ecore.EObject model,
                              org.eclipse.emf.ecore.EStructuralFeature feature,
                              ISelection selection)

Description copied from interface: IDtAction

Executes the action for a given model, model feature and selection.

Specified by:

executeWith in interface IDtAction

Parameters:

model - model to execute with.

feature - feature to execute with.

selection - selection to execute with.

setContextIds

@Deprecated
public void setContextIds(String... contextIds)

Deprecated.

Put action to section with active context DtGranularEditorPageSingleColumnBuilder.section(java.lang.String)

Sets context ids to activate on execute.

Parameters:

contextIds - the context id.

execute

protected void execute(String commandId,
                       org.eclipse.core.commands.ExecutionEvent event)
                throws org.eclipse.core.commands.common.CommandException

Extecute command with the given id and the given execution event.

Parameters:

commandId - the command id, cannot be null

event - the execution event, cannot be null

Throws:

org.eclipse.core.commands.common.CommandException - if comman execution fails

getCommandId

protected abstract String getCommandId()

Returns the command id to execute.

Returns:

the command id to execute, never null

preExecute

protected void preExecute(org.eclipse.emf.ecore.EObject model,
                          org.eclipse.emf.ecore.EStructuralFeature feature,
                          ISelection selection,
                          org.eclipse.core.expressions.IEvaluationContext context,
                          Map<String,String> parameters)

Subclasses may override this method to specify custom pre-execution logic.

Parameters:

model - model to execute with, can be null

feature - feature to execute with, can be {@code null

selection - selection to execute with, cannot be {@code null

parameters - parameters to execute with, cannot be {@code null