Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - MatchHeightAction (Eclipse GEF API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse GEF
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gef.ui.actions
Class MatchHeightAction

java.lang.Object
  

org.eclipse.gef.ui.actions.WorkbenchPartAction
      

org.eclipse.gef.ui.actions.SelectionAction
          org.eclipse.gef.ui.actions.MatchSizeAction
              
org.eclipse.gef.ui.actions.MatchHeightAction

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.

Constructor Summary

MatchHeightAction ( 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 ( PrecisionRectangle precisePartBounds, PrecisionRectangle precisePrimaryBounds)
          Returns the height delta between the two bounds.

protected double getPreciseWidthDelta ( PrecisionRectangle precisePartBounds, 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 java.lang.Object

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

Constructor Detail

MatchHeightAction

public MatchHeightAction(
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(
PrecisionRectangle precisePartBounds,
                                      
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(
PrecisionRectangle precisePartBounds,
                                       
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.