org.argeo.slc.client.ui.dist.utils

Class CommandHelpers

java.lang.Object

org.argeo.slc.client.ui.dist.utils.CommandHelpers

public class CommandHelpers
extends java.lang.Object

Centralizes useful methods to manage command updates

Constructor Summary

Constructors

Constructor and Description
CommandHelpers()

Method Summary

Modifier and Type	Method and Description
static void	callCommand(java.lang.String commandID) Helper to call a command without parameter easily
static void	callCommand(java.lang.String commandID, java.util.Map<java.lang.String,java.lang.String> paramMap) Helper to call a command with a map of parameters easily
static void	callCommand(java.lang.String commandID, java.lang.String parameterID, java.lang.String parameterValue) Helper to call a command with a single parameter easily
static void	refreshCommand(org.eclipse.jface.action.IMenuManager menuManager, org.eclipse.ui.services.IServiceLocator locator, java.lang.String cmdId, java.lang.String label, java.lang.String iconPath, boolean showCommand) Refresh the given command.
static void	refreshParameterizedCommand(org.eclipse.jface.action.IMenuManager menuManager, org.eclipse.ui.services.IServiceLocator locator, java.lang.String cmdId, java.lang.String label, java.lang.String iconPath, boolean showCommand, java.util.Map<java.lang.String,java.lang.String> params) Refresh the given command and optionally corresponding parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandHelpers

public CommandHelpers()

Method Detail

refreshCommand

public static void refreshCommand(org.eclipse.jface.action.IMenuManager menuManager,
                                  org.eclipse.ui.services.IServiceLocator locator,
                                  java.lang.String cmdId,
                                  java.lang.String label,
                                  java.lang.String iconPath,
                                  boolean showCommand)

Refresh the given command.

refreshParameterizedCommand

public static void refreshParameterizedCommand(org.eclipse.jface.action.IMenuManager menuManager,
                                               org.eclipse.ui.services.IServiceLocator locator,
                                               java.lang.String cmdId,
                                               java.lang.String label,
                                               java.lang.String iconPath,
                                               boolean showCommand,
                                               java.util.Map<java.lang.String,java.lang.String> params)

Refresh the given command and optionally corresponding parameters.

Parameters:

menuManager -

locator -

cmdId -

label -

showCommand - Command must be explicitly removed from the context menu at each refresh setting this to false.

params - maps a paramId with a String value

callCommand

public static void callCommand(java.lang.String commandID)

Helper to call a command without parameter easily

callCommand

public static void callCommand(java.lang.String commandID,
                               java.lang.String parameterID,
                               java.lang.String parameterValue)

Helper to call a command with a single parameter easily

callCommand

public static void callCommand(java.lang.String commandID,
                               java.util.Map<java.lang.String,java.lang.String> paramMap)

Helper to call a command with a map of parameters easily

Parameters:

paramMap - a map that links various commands ids with corresponding String values.