diff options
6 files changed, 167 insertions, 94 deletions
diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.java index 6bfa69128..beef9c3b4 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractDebugActionDelegate.java @@ -28,6 +28,13 @@ import org.eclipse.ui.IViewActionDelegate; import org.eclipse.ui.IViewPart; import org.eclipse.ui.IWorkbenchWindow; +/** + * This class is an abstract implementation of common features for a debug <code>IViewActionDelegate</code> + * + * This class is intended to be extended by clients + * @see {@link IViewActionDelegate} + * @see {@link IActionDelegate2} + */ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate, IActionDelegate2 { /** @@ -55,8 +62,7 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate * they can be reflected into existence when referenced in an action set * in the plugin's plugin.xml file. */ - public AbstractDebugActionDelegate() { - } + public AbstractDebugActionDelegate() {} /* (non-Javadoc) * @see org.eclipse.ui.IWorkbenchWindowActionDelegate#dispose() @@ -104,6 +110,10 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate reportErrors(status); } + /** + * Reports the specified <code>MultiStatus</code> in an error dialog + * @param ms the specified <code>MultiStatus</code> + */ private void reportErrors(final MultiStatus ms) { if (!ms.isOK()) { IWorkbenchWindow window= DebugUIPlugin.getActiveWorkbenchWindow(); @@ -127,6 +137,12 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate } } + /** + * Updates the specified selection based on the selection, as well as setting the selection + * for this action + * @param action the action to update + * @param s the selection + */ protected void update(IAction action, ISelection s) { if (s instanceof IStructuredSelection) { IStructuredSelection ss = (IStructuredSelection)s; @@ -216,18 +232,34 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate fSelection = selection; } + /** + * Allows the underlying <code>IAction</code> to be set to the specified <code>IAction</code> + * @param action the action to set + */ protected void setAction(IAction action) { fAction = action; } + /** + * Allows access to the underlying <code>IAction</code> + * @return the underlying <code>IAction</code> + */ protected IAction getAction() { return fAction; } + /** + * Returns if this action has been initialized or not + * @return if this action has been initialized or not + */ protected boolean isInitialized() { return fInitialized; } + /** + * Sets the initialized state of this aciton to the specified boolean value + * @param initialized the value to set the initialized state to + */ protected void setInitialized(boolean initialized) { fInitialized = initialized; } @@ -249,6 +281,11 @@ public abstract class AbstractDebugActionDelegate implements IViewActionDelegate return true; } + /** + * Returns if this action is enabled for the specified object context + * @param element the context + * @return true if it is, false otherwise + */ protected boolean isEnabledFor(Object element) { return true; } diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.java index ef4bc97eb..53d5662c0 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveActionDelegate.java @@ -14,6 +14,15 @@ package org.eclipse.debug.internal.ui.actions; import org.eclipse.debug.ui.IDebugView; import org.eclipse.ui.IViewPart; +/** + * Base implementation of the 'remove' action for a debug view + * + * This class is intended to be extended by clients + * @see {@link AbstractSelectionActionDelegate} + * @see {@link org.eclipse.ui.IViewActionDelegate} + * @see {@link org.eclipse.ui.IActionDelegate2} + * + */ public abstract class AbstractRemoveActionDelegate extends AbstractSelectionActionDelegate { /* (non-Javadoc) diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.java index 3d2fbb5c5..234b478c7 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractRemoveAllActionDelegate.java @@ -20,8 +20,19 @@ import org.eclipse.ui.IViewPart; import org.eclipse.ui.IWorkbenchWindow; import org.eclipse.ui.IWorkbenchWindowActionDelegate; +/** + * This class is a base implementation of a 'remove all' debug action + * + * This class is intended to be extended by clients + * @see {@link IViewActionDelegate} + * @see {@link IActionDelegate2}} + * @see {@link IWorkbenchWindowActionDelegate} + */ public abstract class AbstractRemoveAllActionDelegate implements IViewActionDelegate, IActionDelegate2, IWorkbenchWindowActionDelegate { + /** + * The underlying <code>IAction</code> + */ private IAction fAction; /** @@ -46,7 +57,7 @@ public abstract class AbstractRemoveAllActionDelegate implements IViewActionDele /** * Returns this delegate's action. * - * @return + * @return the underlying <code>IAction</code> */ protected IAction getAction() { return fAction; @@ -93,7 +104,7 @@ public abstract class AbstractRemoveAllActionDelegate implements IViewActionDele /** * Returns whether this action is enabled * - * @return + * @return true if this action is enabled, false otherwise */ protected abstract boolean isEnabled(); @@ -103,5 +114,4 @@ public abstract class AbstractRemoveAllActionDelegate implements IViewActionDele public void selectionChanged(IAction action, ISelection s) { // do nothing } - } diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.java index 306e2cd16..34b01df50 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AbstractSelectionActionDelegate.java @@ -24,6 +24,16 @@ import org.eclipse.ui.IViewActionDelegate; import org.eclipse.ui.IViewPart; import org.eclipse.ui.progress.IWorkbenchSiteProgressService; +/** + * This class provides a base implementation of a selection action delegate, more specifically a delegate + * that uses a selection context to update its underlying <code>IAction</code>. + * + * This class is intended to be extended by clients + * + * @see {@link IViewActionDelegate} + * @see {@link IActionDelegate2} + * + */ public abstract class AbstractSelectionActionDelegate implements IViewActionDelegate, IActionDelegate2 { /** @@ -38,7 +48,7 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele private IViewPart fViewPart; /** - * Cache of the most recent seletion + * Cache of the most recent selection */ private IStructuredSelection fSelection = StructuredSelection.EMPTY; @@ -52,8 +62,7 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele * they can be reflected into existence when referenced in an action set in * the plugin's plugin.xml file. */ - public AbstractSelectionActionDelegate() { - } + public AbstractSelectionActionDelegate() {} /* * (non-Javadoc) @@ -64,6 +73,9 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele fSelection = null; } + /* (non-Javadoc) + * @see org.eclipse.ui.IActionDelegate#selectionChanged(org.eclipse.jface.action.IAction, org.eclipse.jface.viewers.ISelection) + */ public void selectionChanged(IAction action, ISelection s) { if (s instanceof IStructuredSelection) { IStructuredSelection ss = (IStructuredSelection) s; @@ -79,6 +91,8 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele * Returns the String to use as an error dialog message for a failed action. * This message appears as the "Message:" in the error dialog for this * action. Default is to return null. + * + * @return the message for the error dialog */ protected String getErrorDialogMessage() { return null; @@ -88,6 +102,8 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele * Returns the String to use as a status message for a failed action. This * message appears as the "Reason:" in the error dialog for this action. * Default is to return the empty String. + * + * @return the status message */ protected String getStatusMessage() { return ""; //$NON-NLS-1$ @@ -107,7 +123,7 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele * Returns this action's view part, or <code>null</code> if not installed * in a view. * - * @return view part or <code>null</code> + * @return the underlying <code>IViewPart</code> or <code>null</code> */ protected IViewPart getView() { return fViewPart; @@ -131,14 +147,26 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele fSelection = context; } + /** + * Allows the underlying <code>IAction</code> to be set to the specified one + * @param action the action to set + */ protected void setAction(IAction action) { fAction = action; } + /** + * Allows access to the underlying <code>IAction</code> + * @return the underlying <code>IAction</code> + */ protected IAction getAction() { return fAction; } + /** + * Allows the underlying <code>IViewPart</code> to be set + * @param viewPart the <code>IViewPart</code> to set + */ protected void setView(IViewPart viewPart) { fViewPart = viewPart; } @@ -146,6 +174,9 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele /** * Return whether the action should be enabled or not based on the given * selection. + * + * @return true if the action should be enabled for the specified selection context + * false otherwise */ protected boolean getEnableStateForSelection(IStructuredSelection selection) { if (selection.size() == 0) { @@ -161,6 +192,12 @@ public abstract class AbstractSelectionActionDelegate implements IViewActionDele return true; } + /** + * Returns if the action should be enabled for the specified object context + * @param element the object context + * @return true if the action should be enabled for the specified object context + * false otherwise + */ protected boolean isEnabledFor(Object element) { return true; } diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/ActionMessages.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/ActionMessages.java index 4f6c6b1ea..c7dd35811 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/ActionMessages.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/ActionMessages.java @@ -14,6 +14,12 @@ import org.eclipse.osgi.util.NLS; public class ActionMessages extends NLS { private static final String BUNDLE_NAME = "org.eclipse.debug.internal.ui.actions.ActionMessages";//$NON-NLS-1$ + public static String AbstractLaunchHistoryAction_0; + public static String AbstractLaunchHistoryAction_1; + public static String AbstractLaunchHistoryAction_2; + public static String AbstractLaunchHistoryAction_3; + public static String AbstractLaunchHistoryAction_4; + public static String AddToFavoritesAction_1; public static String AddToFavoritesAction_2; public static String AddToFavoritesAction_3; @@ -29,19 +35,18 @@ public class ActionMessages extends NLS { public static String CollapseAllAction_0; + public static String ConfigureColumnsAction_0; + public static String ConfigureColumnsAction_1; + public static String ConfigureColumnsAction_2; + public static String CopyToClipboardActionDelegate_Problem_Copying_to_Clipboard_1; public static String CopyToClipboardActionDelegate_There_was_a_problem_when_accessing_the_system_clipboard__Retry__2; public static String DetailPaneAssignValueAction_0; - public static String DetailPaneAssignValueAction_1; - public static String DetailPaneAssignValueAction_2; - public static String DetailPaneAssignValueAction_3; - public static String DetailPaneAssignValueAction_4; - public static String DetailPaneWordWrapAction_0; public static String DetailPaneMaxLengthAction_0; @@ -58,16 +63,22 @@ public class ActionMessages extends NLS { public static String RelaunchActionDelegate_An_exception_occurred_while_launching_2; public static String RelaunchActionDelegate_Launch_Failed_1; - + public static String RelaunchLastAction_Cannot_relaunch_1; + public static String RelaunchLastAction_Cannot_relaunch___0___because_it_does_not_support__2__mode_2; + public static String RelaunchLastAction_Error_relaunching_3; + public static String RelaunchLastAction_Error_encountered_attempting_to_relaunch_4; + public static String RemoveAllBreakpointsAction_0; public static String RemoveAllBreakpointsAction_1; public static String RemoveAllBreakpointsAction_2; - public static String RemoveAllBreakpointsAction_3; - public static String RemoveBreakpointAction_0; public static String RemoveBreakpointAction_1; public static String RemoveBreakpointAction_2; + public static String RemoveBreakpointAction_3; + public static String RemoveBreakpointAction_4; + public static String RemoveBreakpointAction_5; + public static String RemoveBreakpointAction_6; public static String RemoveBreakpointAction_Exceptions_occurred_attempting_to_remove_a_breakpoint__5; public static String RemoveBreakpointAction_Removing_a_breakpoint_4; @@ -77,17 +88,15 @@ public class ActionMessages extends NLS { public static String ShowTypesAction_Show__Type_Names_1; public static String ShowTypesAction_Show_Type_Names; - public static String RelaunchLastAction_Cannot_relaunch_1; - public static String RelaunchLastAction_Cannot_relaunch___0___because_it_does_not_support__2__mode_2; - public static String RelaunchLastAction_Error_relaunching_3; - public static String RelaunchLastAction_Error_encountered_attempting_to_relaunch_4; - - public static String AbstractLaunchHistoryAction_0; - public static String AbstractLaunchHistoryAction_1; - public static String AbstractLaunchHistoryAction_2; - public static String AbstractLaunchHistoryAction_3; - public static String AbstractLaunchHistoryAction_4; - + public static String SkipAllBreakpointsAction_0; + public static String SkipAllBreakpointsAction_2; + + public static String TerminateAndRelaunchAction_0; + public static String TerminateAndRelaunchAction_3; + public static String TerminateAndRelaunchAction_4; + public static String TerminateAndRemoveAction_0; + public static String TerminateAndRemoveAction_3; + public static String ToggleDetailPaneAction_1; public static String ToggleDetailPaneAction_2; public static String ToggleDetailPaneAction_3; @@ -99,7 +108,6 @@ public class ActionMessages extends NLS { public static String ToggleBreakpointAction_0; public static String ToggleBreakpointAction_1; public static String ToggleBreakpointAction_2; - public static String ToggleStepFiltersAction_0; public static String WatchExpressionDialog_0; @@ -109,8 +117,7 @@ public class ActionMessages extends NLS { public static String WatchExpressionDialog_4; public static String WatchAction_0; public static String WatchAction_1; - public static String SkipAllBreakpointsAction_0; - public static String SkipAllBreakpointsAction_2; + public static String RunToLineAction_0; public static String RunToLineAction_1; public static String RunToLineHandler_0; @@ -120,6 +127,8 @@ public class ActionMessages extends NLS { public static String RetargetAction_3; public static String ModifyWatchpointAction_0; public static String ModifyWatchpointAction_1; + public static String RemoveAllExpressionsAction_0; + public static String RemoveAllExpressionsAction_1; public static String LaunchShortcutsAction_1; public static String FindDialog_1; public static String FindDialog_3; @@ -133,90 +142,37 @@ public class ActionMessages extends NLS { public static String AbstractDebugActionDelegate_0; public static String RetargetAddMemoryBlockAction_0; - public static String RetargetAddMemoryBlockAction_1; - public static String AddMemoryRenderingActionDelegate_0; - public static String AddMemoryRenderingActionDelegate_1; - public static String AddMemoryRenderingActionDelegate_2; public static String RulerEnableDisableBreakpointAction_0; - public static String RulerEnableDisableBreakpointAction_1; - public static String RulerEnableDisableBreakpointAction_2; - public static String RulerEnableDisableBreakpointAction_3; - public static String RemoveAllExpressionsAction_0; - - public static String RemoveAllExpressionsAction_1; - - public static String TerminateAndRelaunchAction_0; - - public static String TerminateAndRelaunchAction_3; - - public static String TerminateAndRelaunchAction_4; - - public static String StepReturnAction_2; - - public static String StepReturnAction_3; - - public static String TerminateAndRemoveAction_0; - - public static String TerminateAndRemoveAction_3; - - public static String ResumeAction_0; - - public static String ResumeAction_3; - public static String DisconnectAction_0; - public static String DisconnectAction_3; - - public static String StepIntoAction_0; - - public static String StepIntoAction_3; - public static String DropToFrameAction_0; - public static String DropToFrameAction_3; - - public static String TerminateAllAction_2; - - public static String TerminateAllAction_3; - - public static String SuspendAction_0; - - public static String SuspendAction_3; - + public static String ResumeAction_0; + public static String ResumeAction_3; + public static String StepIntoAction_0; + public static String StepIntoAction_3; public static String StepOverAction_0; - public static String StepOverAction_3; - + public static String StepReturnAction_2; + public static String StepReturnAction_3; + public static String SuspendAction_0; + public static String SuspendAction_3; public static String TerminateAction_0; - public static String TerminateAction_3; - - public static String ConfigureColumnsAction_0; - - public static String ConfigureColumnsAction_1; - - public static String ConfigureColumnsAction_2; + public static String TerminateAllAction_2; + public static String TerminateAllAction_3; public static String DeleteWorkingsetsMessageDialog_0; - public static String DeleteWorkingsetsMessageDialog_1; - public static String RemoveBreakpointAction_3; - - public static String RemoveBreakpointAction_4; - - public static String RemoveBreakpointAction_5; - - public static String RemoveBreakpointAction_6; - public static String ShowTypesAction_0; }
\ No newline at end of file diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.java index 6803f61ec..7603a7525 100644 --- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.java +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/actions/AddToFavoritesAction.java @@ -110,26 +110,50 @@ public class AddToFavoritesAction extends SelectionListenerAction { return false; } + /** + * Allows the underlying <code>ILaunchConfiguration</code> to be set + * @param configuration the new configuration to set + */ protected void setLaunchConfiguration(ILaunchConfiguration configuration) { fConfiguration = configuration; } + /** + * Returns the underlying <code>ILaunchConfiguration</code> + * @return the underlying <code>ILaunchConfiguration</code> + */ protected ILaunchConfiguration getLaunchConfiguration() { return fConfiguration; } + /** + * Sets the mode this action applies to + * @param mode the modes to set + */ protected void setMode(String mode) { fMode = mode; } + /** + * Returns the mode this action applies to + * @return + */ protected String getMode() { return fMode; } + /** + * Sets the <code>ILaunchGroup</code> this action applies to + * @param group the new <code>ILaunchGroup</code> + */ protected void setGroup(ILaunchGroup group) { fGroup = group; } + /** + * Returns the underlying <code>ILaunchGroup</code> + * @return the underlying <code>ILaunchGroup</code> + */ protected ILaunchGroup getGroup() { return fGroup; } |