org.eclipse.gef.ui.actions
Class MatchHeightAction

java.lang.Object
  extended byorg.eclipse.jface.action.Action
      extended byorg.eclipse.gef.ui.actions.WorkbenchPartAction
          extended byorg.eclipse.gef.ui.actions.SelectionAction
              extended byorg.eclipse.gef.ui.actions.MatchSizeAction
                  extended byorg.eclipse.gef.ui.actions.MatchHeightAction
All Implemented Interfaces:
Disposable, org.eclipse.jface.action.IAction, UpdateAction

public class MatchHeightAction
extends org.eclipse.gef.ui.actions.MatchSizeAction

An action that matches the height of all selected EditPart's Figures to the width of the Primary Selection EditPart's Figure.


Field Summary
 
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, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
MatchHeightAction(org.eclipse.ui.IWorkbenchPart part)
          Constructs a MatchHeightAction and associates it with the given part.
 
Method Summary
protected  boolean calculateEnabled()
          Calculates and returns the enabled state of this action.
protected  double getPreciseHeightDelta(org.eclipse.draw2d.geometry.PrecisionRectangle precisePartBounds, org.eclipse.draw2d.geometry.PrecisionRectangle precisePrimaryBounds)
          Returns the height delta between the two bounds.
protected  double getPreciseWidthDelta(org.eclipse.draw2d.geometry.PrecisionRectangle precisePartBounds, org.eclipse.draw2d.geometry.PrecisionRectangle precisePrimaryBounds)
          Returns 0 to make this action affect only the height delta.
 void run()
          Executes this action, cycling through the selected EditParts in the Action's viewer, and matching the size of the selected EditPart's Figures to that of the Primary Selection's Figure.
 
Methods inherited from class org.eclipse.gef.ui.actions.SelectionAction
dispose, getSelectedObjects, getSelection, handleSelectionChanged, setSelection, setSelectionProvider, update
 
Methods inherited from class org.eclipse.gef.ui.actions.WorkbenchPartAction
execute, getCommandStack, getWorkbenchPart, init, isEnabled, refresh, setLazyEnablementCalculation, setWorkbenchPart
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MatchHeightAction

public MatchHeightAction(org.eclipse.ui.IWorkbenchPart part)
Constructs a MatchHeightAction and associates it with the given part.

Parameters:
part - The workbench part associated with this MatchHeightAction
Method Detail

getPreciseWidthDelta

protected double getPreciseWidthDelta(org.eclipse.draw2d.geometry.PrecisionRectangle precisePartBounds,
                                      org.eclipse.draw2d.geometry.PrecisionRectangle precisePrimaryBounds)
Returns 0 to make this action affect only the height delta.

Parameters:
precisePartBounds - the precise bounds of the EditPart's Figure to be matched
precisePrimaryBounds - the precise bounds of the Primary Selection EditPart's Figure
Returns:
0.

calculateEnabled

protected boolean calculateEnabled()
Description copied from class: WorkbenchPartAction
Calculates and returns the enabled state of this action.

Specified by:
calculateEnabled in class WorkbenchPartAction
Returns:
true if the action is enabled
See Also:
WorkbenchPartAction.calculateEnabled()

getPreciseHeightDelta

protected double getPreciseHeightDelta(org.eclipse.draw2d.geometry.PrecisionRectangle precisePartBounds,
                                       org.eclipse.draw2d.geometry.PrecisionRectangle precisePrimaryBounds)
Returns the height delta between the two bounds. Separated into a method so that it can be overriden to return 0 in the case of a width-only action.

Parameters:
precisePartBounds - the precise bounds of the EditPart's Figure to be matched
precisePrimaryBounds - the precise bounds of the Primary Selection EditPart's Figure
Returns:
the delta between the two heights to be used in the Request.

run

public void run()
Executes this action, cycling through the selected EditParts in the Action's viewer, and matching the size of the selected EditPart's Figures to that of the Primary Selection's Figure.