Package org.eclipse.draw2d
Class OrderedLayout
java.lang.Object
org.eclipse.draw2d.AbstractLayout
org.eclipse.draw2d.AbstractHintLayout
org.eclipse.draw2d.OrderedLayout
- All Implemented Interfaces:
LayoutManager
- Direct Known Subclasses:
FlowLayout,ToolbarLayout
Abstract superclass for layout managers that arrange their children in
columns/rows.
- Since:
- 3.7
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intConstant to specify components to be aligned on the right/bottomstatic final intConstant to specify components to be aligned in the centerstatic final intConstant to specify components to be aligned on the left/topprotected booleanDeprecated.static final booleanDeprecated.Pulled up from derived layout manager and deprecated here because unused.protected intDeprecated.UsegetMinorAlignment()andsetMinorAlignment(int)instead.protected TransposerTransposer object that may be used in layout calculations.static final booleanDeprecated.Pulled up from derived layout manager and deprecated here because unused.Fields inherited from class org.eclipse.draw2d.AbstractLayout
isObservingVisibility, preferredSize -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newOrderedLayoutwith the default orientation and a minor alignment ofALIGN_TOPLEFT. -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract intReturns the default orientation of this layout.intReturns the minor alignment of the layout.booleanReturnstrueif the orientation of the layout is horizontal.abstract booleanReturns whether figures should obtain the same height/width in the minor axis.voidsetHorizontal(boolean flag) Sets the orientation of the layout.voidsetMinorAlignment(int align) Sets the alignment of the children contained in the layout.abstract voidsetStretchMinorAxis(boolean value) Causes children that are smaller in the dimension of the minor axis to be stretched to fill the minor axis.Methods inherited from class org.eclipse.draw2d.AbstractHintLayout
calculateMinimumSize, getMinimumSize, getPreferredSize, invalidate, isSensitiveHorizontally, isSensitiveVerticallyMethods inherited from class org.eclipse.draw2d.AbstractLayout
calculatePreferredSize, calculatePreferredSize, getBorderPreferredSize, getConstraint, getMinimumSize, getPreferredSize, invalidate, isObservingVisibility, remove, setConstraint, setObserveVisibilityMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.draw2d.LayoutManager
layout
-
Field Details
-
ALIGN_CENTER
public static final int ALIGN_CENTERConstant to specify components to be aligned in the center- See Also:
-
ALIGN_TOPLEFT
public static final int ALIGN_TOPLEFTConstant to specify components to be aligned on the left/top- See Also:
-
ALIGN_BOTTOMRIGHT
public static final int ALIGN_BOTTOMRIGHTConstant to specify components to be aligned on the right/bottom- See Also:
-
HORIZONTAL
Deprecated.Pulled up from derived layout manager and deprecated here because unused.Constant to specify components should be layed out horizontally- See Also:
-
VERTICAL
Deprecated.Pulled up from derived layout manager and deprecated here because unused.Constant to specify components should be layed out vertically- See Also:
-
horizontal
Deprecated.UsesetHorizontal(boolean)andisHorizontal()instead.The horizontal property. -
minorAlignment
Deprecated.UsegetMinorAlignment()andsetMinorAlignment(int)instead.The alignment along the minor axis. -
transposer
Transposer object that may be used in layout calculations. Will be automatically enabled/disabled dependent on the default and the actual orientation.- @noreference
- This field is not intended to be referenced by clients.
-
-
Constructor Details
-
OrderedLayout
public OrderedLayout()Constructs a newOrderedLayoutwith the default orientation and a minor alignment ofALIGN_TOPLEFT.
-
-
Method Details
-
getDefaultOrientation
protected abstract int getDefaultOrientation()Returns the default orientation of this layout.- Returns:
- one of
PositionConstants.HORIZONTALorPositionConstants.VERTICAL
-
getMinorAlignment
public int getMinorAlignment()Returns the minor alignment of the layout. Minor minor axis is the axis perpendicular to the overall orientation set in the constructor.- Returns:
- the minor alignment
-
isHorizontal
public boolean isHorizontal()Returnstrueif the orientation of the layout is horizontal.- Returns:
trueif the orientation of the layout is horizontal
-
isStretchMinorAxis
public abstract boolean isStretchMinorAxis()Returns whether figures should obtain the same height/width in the minor axis.- Returns:
- whether children are to be stretched in the minor axis.
- TODO
- Made abstract here, so that derived layout managers can guarantee backwards compatibility for their exposed fields. Can be made concrete in the next major release, removing implementations in the derived layout managers.
-
setHorizontal
public void setHorizontal(boolean flag) Sets the orientation of the layout.- Parameters:
flag-trueif this layout should be horizontal,falseotherwise.
-
setMinorAlignment
public void setMinorAlignment(int align) Sets the alignment of the children contained in the layout. Possible values areALIGN_CENTER,ALIGN_BOTTOMRIGHTandALIGN_TOPLEFT.- Parameters:
align- the minor alignment
-
setStretchMinorAxis
public abstract void setStretchMinorAxis(boolean value) Causes children that are smaller in the dimension of the minor axis to be stretched to fill the minor axis. The minor axis is the opposite of the orientation. That is, in horizontal orientation, all figures will have the same height. If in vertical orientation, all figures will have the same width.- Parameters:
value- whether children should be stretched in the minor axis.- TODO
- Made abstract here, so that derived layout managers can guarantee backwards compatibility for their exposed fields. Can be made concrete in the next major release, removing implementations in the derived layout managers.
-
setHorizontal(boolean)andisHorizontal()instead.