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 AlignmentAction

java.lang.Object
  

org.eclipse.gef.ui.actions.WorkbenchPartAction
      

org.eclipse.gef.ui.actions.SelectionAction
          
org.eclipse.gef.ui.actions.AlignmentAction

---

public final class AlignmentAction

extends SelectionAction

An action to align the selected parts.

---

Field Summary
static java.lang.String	ID_ALIGN_BOTTOM           Indicates that the bottom edges should be aligned.
static java.lang.String	ID_ALIGN_CENTER           Indicates that the horizontal centers should be aligned.
static java.lang.String	ID_ALIGN_LEFT           Indicates that the left edges should be aligned.
static java.lang.String	ID_ALIGN_MIDDLE           Indicates that the vertical midpoints should be aligned.
static java.lang.String	ID_ALIGN_RIGHT           Indicates that the right edges should be aligned.
static java.lang.String	ID_ALIGN_TOP           Indicates that the top edges should be aligned.

 

Constructor Summary

AlignmentAction ( IEditorPart editor, int align)           Deprecated. use AlignmentAction(IWorkbenchPart, int align)

AlignmentAction ( IWorkbenchPart part, int align)           Constructs an AlignmentAction with the given part and alignment ID.

 

Method Summary
protected   Rectangle	calculateAlignmentRectangle ( Request request)           Returns the alignment rectangle to which all selected parts should be aligned.
protected  boolean	calculateEnabled ()           Calculates and returns the enabled state of this action.
void	dispose ()           Disposes the action when it is no longer needed.
protected  java.util.List	getOperationSet ( Request request)           Returns the list of editparts which will participate in alignment.
protected  void	initUI ()           Initializes the actions UI presentation.
void	run ()

 

Methods inherited from class org.eclipse.gef.ui.actions. SelectionAction

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

 

Field Detail

ID_ALIGN_BOTTOM

public static final java.lang.String ID_ALIGN_BOTTOM

Indicates that the bottom edges should be aligned.

See Also:

Constant Field Values

---

ID_ALIGN_CENTER

public static final java.lang.String ID_ALIGN_CENTER

Indicates that the horizontal centers should be aligned.

See Also:

Constant Field Values

---

ID_ALIGN_LEFT

public static final java.lang.String ID_ALIGN_LEFT

Indicates that the left edges should be aligned.

See Also:

Constant Field Values

---

ID_ALIGN_MIDDLE

public static final java.lang.String ID_ALIGN_MIDDLE

Indicates that the vertical midpoints should be aligned.

See Also:

Constant Field Values

---

ID_ALIGN_RIGHT

public static final java.lang.String ID_ALIGN_RIGHT

Indicates that the right edges should be aligned.

See Also:

Constant Field Values

---

ID_ALIGN_TOP

public static final java.lang.String ID_ALIGN_TOP

Indicates that the top edges should be aligned.

See Also:

Constant Field Values

Constructor Detail

AlignmentAction

public AlignmentAction(
IEditorPart editor,
                       int align)

Deprecated. use AlignmentAction(IWorkbenchPart, int align)

Parameters:

editor - the editor

align - the alignment ID

---

AlignmentAction

public AlignmentAction(
IWorkbenchPart part,
                       int align)

Constructs an AlignmentAction with the given part and alignment ID. The alignment ID must by one of:

• GEFActionConstants.ALIGN_LEFT
• GEFActionConstants.ALIGN_RIGHT
• GEFActionConstants.ALIGN_CENTER
• GEFActionConstants.ALIGN_TOP
• GEFActionConstants.ALIGN_BOTTOM
• GEFActionConstants.ALIGN_MIDDLE

Parameters:

part - the workbench part used to obtain context

align - the aligment ID.

Method Detail

calculateAlignmentRectangle

protected 
Rectangle calculateAlignmentRectangle(
Request request)

Returns the alignment rectangle to which all selected parts should be aligned.

Parameters:

request - the alignment Request

Returns:

the alignment rectangle

---

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()

---

dispose

public void dispose()

Description copied from class: WorkbenchPartAction

Disposes the action when it is no longer needed.

Overrides:

dispose in class SelectionAction

See Also:

Disposable.dispose()

---

getOperationSet

protected java.util.List getOperationSet(
Request request)

Returns the list of editparts which will participate in alignment.

Parameters:

request - the alignment request

Returns:

the list of parts which will be aligned

---

initUI

protected void initUI()

Initializes the actions UI presentation.

---

run

public void run()

See Also:

IAction.run()

---

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

---

Copyright (c) IBM Corp. and others 2000, 2007. All Rights Reserved.