Layout

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.google.gwt.user.client.ui.Panel
    - - com.google.gwt.user.client.ui.ComplexPanel
      - com.smartgwt.mobile.client.widgets.Canvas
        
        com.smartgwt.mobile.client.widgets.layout.Layout

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.smartgwt.mobile.client.internal.test.AutoTestLocatable, HasClickHandlers, HasDragMoveHandlers, HasShowContextMenuHandlers, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

HLayout, HStack, Panel, TabSet, VLayout, VStack
```
public class Layout
extends Canvas
implements HasDragMoveHandlers
```
A subclass of Canvas that automatically arranges other Canvases according to a layout policy.

A Layout manages a set of "member" Canvases initialized via the "members" property. Layouts can have both "members", which are managed by the Layout, and normal Canvas children, which are unmanaged.

Rather than using the Layout class directly, use the HLayout, VLayout, HStack and VStack classes, which are subclasses of Layout preconfigured for horizontal or vertical stacking, with the "fill" (VLayout) or "none" (VStack) policies already set.

Layouts and Stacks may be nested to create arbitrarily complex layouts. Like other Canvas subclasses, Layout and Stack components may have % width and height values. To create a dynamically-resizing layout that occupies the entire page (or entire parent component), set width and height to "100%".

See Also:

LayoutPolicy, VLayout, HLayout, VStack, HStack, LayoutSpacer

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
  com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
- Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel
  com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget
- Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets
  com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields
Modifier and Type	Field and Description
`protected Alignment`	`alignment`
`protected java.lang.Boolean`	`enforcePolicy`
`protected LayoutPolicy`	`hPolicy`
`protected java.util.List<Canvas>`	`members`
`protected int`	`membersMargin`
`protected int`	`minMemberSize`
`protected boolean`	`momentumScroll`
`protected Overflow`	`overflow`
`protected boolean`	`paddingAsLayoutMargin`
`protected java.lang.Boolean`	`reverseOrder`
`protected VerticalAlignment`	`valign`
`protected java.lang.Boolean`	`vertical`

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas
_CONTENT_CHANGED_EVENT_TYPE, _CSS, _HISTORY_ENABLED, _REQUEST_SCROLL_TO_EVENT_TYPE, id, touched

Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX

Constructor Summary

Constructors
Constructor and Description

Layout()

Constructors
Constructor and Description
`Layout()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.gwt.event.shared.HandlerRegistration`	`addDragMoveHandler(DragMoveHandler dragMoveHandler)` Executed every time the mouse moves while dragging this canvas.
`void`	`addMember(Canvas component)` Add a canvas to the layout.
`void`	`addMember(Canvas component, int position)` Adds a component to the layout at the specified position.
`void`	`addMember(com.google.gwt.user.client.ui.Widget widget)`
`void`	`addMember(com.google.gwt.user.client.ui.Widget widget, int position)`
`void`	`addMembers(Canvas... members)` Add one or more canvases to the layout
`void`	`addMembers(Canvas[] members, int position)` Add one or more canvases to the layout at specific positions.
`void`	`addMembers(java.lang.Iterable<? extends Canvas> members, int position)`
`void`	`clear()`
`java.lang.Boolean`	`getEnforcePolicy()` Whether the layout policy is continuously enforced as new members are added or removed and as members are resized.
`LayoutPolicy`	`getHPolicy()` Sizing policy applied to members on horizontal axis
`java.lang.Integer`	`getLayoutBottomMargin()` Space outside of all members, on the bottom side.
`java.lang.Integer`	`getLayoutLeftMargin()` Space outside of all members, on the left-hand side.
`java.lang.Integer`	`getLayoutMargin()` Space outside of all members.
`java.lang.Integer`	`getLayoutRightMargin()` Space outside of all members, on the right-hand side.
`java.lang.Integer`	`getLayoutTopMargin()` Space outside of all members, on the top side.
`java.lang.Boolean`	`getManagePercentBreadth()` If set, a Layout with breadthPolicy:"fill" will specially interpret a percentage breadth on a member as a percentage of available space excluding the `layoutMargin`.
`Canvas`	`getMember(int index)` Given a numerical index or a member ID, return a pointer to the appropriate member.
`Canvas`	`getMember(java.lang.String memberID)` Given a numerical index or a member ID, return a pointer to the appropriate member.
`int`	`getMemberNumber(Canvas member)` Given a member Canvas or member ID, return the index of that member within this layout's members array
`int`	`getMemberNumber(java.lang.String memberID)` Given a member Canvas or member ID, return the index of that member within this layout's members array
`Canvas[]`	`getMembers()` Return the members in the Layout.
`int`	`getMembersMargin()` Space between each member of the layout.
`int`	`getMinMemberSize()` Minimum size, in pixels, below which members should never be shrunk, even if this requires the Layout to overflow.
`boolean`	`getMomentumScroll()` Return if momentum scroll is enabled.
`Overflow`	`getOverflow()` Normal `Overflow` settings can be used on layouts, for example, an overflow:auto Layout will scroll if members exceed its specified size, whereas an overflow:visible Layout will grow to accommodate members.
`java.lang.Boolean`	`getPaddingAsLayoutMargin()` If this widget has padding specified or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
`java.lang.Boolean`	`getReverseOrder()` Reverse the order of stacking for this Layout, so that the last member is shown first.
`java.lang.Boolean`	`getVertical()` Should this layout appear with members stacked vertically or horizontally.
`LayoutPolicy`	`getVPolicy()` Sizing policy applied to members on vertical axis
`java.lang.Boolean`	`hasMember(Canvas canvas)` Returns true if the layout includes the specified canvas.
`void`	`hideMember(Canvas member)` Hide the specified member, firing the specified callback when the hide is complete.
`void`	`hideMember(Canvas member, Function callback)` Hide the specified member, firing the specified callback when the hide is complete.
`void`	`reflow()` Layout members according to current settings.
`void`	`removeMember(Canvas member)` Removes the specified member from the layout.
`void`	`removeMember(com.google.gwt.user.client.ui.Widget widget)`
`void`	`removeMembers(Canvas... members)`
`void`	`removeMembers(java.lang.Iterable<? extends Canvas> iterable)`
`void`	`reorderMember(int memberNum, int newPosition)` Shift a member of the layout to a new position
`void`	`reorderMembers(int start, int end, int newPosition)` Move a range of members to a new position
`void`	`setAlign(Alignment alignment)` Alignment of all members in this Layout on the length axis.
`void`	`setAlign(VerticalAlignment valign)` Alignment of all members in this Layout on the length axis.
`void`	`setDefaultLayoutAlign(Alignment alignment)` Specifies the default alignment for layout members on the breadth axis.
`void`	`setDefaultLayoutAlign(VerticalAlignment alignment)` Specifies the default alignment for layout members on the breadth axis.
`void`	`setEnforcePolicy(java.lang.Boolean enforcePolicy)` Whether the layout policy is continuously enforced as new members are added or removed and as members are resized.
`void`	`setHPolicy(LayoutPolicy hPolicy)` Sizing policy applied to members on horizontal axis
`void`	`setLayoutBottomMargin(java.lang.Integer layoutBottomMargin)` Space outside of all members, on the bottom side.
`void`	`setLayoutLeftMargin(java.lang.Integer layoutLeftMargin)` Space outside of all members, on the left-hand side.
`void`	`setLayoutMargin(java.lang.Integer layoutMargin)` Space outside of all members.
`void`	`setLayoutRightMargin(java.lang.Integer layoutRightMargin)` Space outside of all members, on the right-hand side.
`void`	`setLayoutTopMargin(java.lang.Integer layoutTopMargin)` Space outside of all members, on the top side.
`void`	`setManagePercentBreadth(java.lang.Boolean managePercentBreadth)` If set, a Layout with breadthPolicy:"fill" will specially interpret a percentage breadth on a member as a percentage of available space excluding the `layoutMargin`.
`void`	`setMembers(Canvas... members)` An array of canvases that will be contained within this layout.
`void`	`setMembersMargin(int membersMargin)` Space between each member of the layout.
`void`	`setMinMemberSize(int minMemberSize)` Minimum size, in pixels, below which members should never be shrunk, even if this requires the Layout to overflow.
`void`	`setMomentumScroll(boolean onoff)` Enable/disable momentum scroll
`void`	`setOverflow(Overflow overflow)` Normal `Overflow` settings can be used on layouts, for example, an overflow:auto Layout will scroll if members exceed its specified size, whereas an overflow:visible Layout will grow to accommodate members.
`void`	`setPaddingAsLayoutMargin(java.lang.Boolean paddingAsLayoutMargin)` If this widget has padding specified (or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
`void`	`setReverseOrder(java.lang.Boolean reverseOrder)` Reverse the order of stacking for this Layout, so that the last member is shown first.
`void`	`setVertical(java.lang.Boolean vertical)` Should this layout appear with members stacked vertically or horizontally.
`void`	`setVisibleMember(Canvas member)` Hide all other members and make the single parameter member visible.
`void`	`setVPolicy(LayoutPolicy vPolicy)` Sizing policy applied to members on vertical axis
`void`	`showMember(Canvas member)` Show the specified member, firing the specified callback when the hide is complete.
`void`	`showMember(Canvas member, Function callback)` Show the specified member, firing the specified callback when show is complete.

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas
_add, _booleanValue, _fireContentChangedEvent, _fireContentChangedEvent, _fireRequestScrollToEvent, _getAndroidWindowSoftInputMode, _getAttributeFromSplitLocator, _getChildFromLocatorSubstring, _getFixNavigationBarPositionDuringKeyboardFocus, _getHideTabBarDuringKeyboardFocus, _getInnerAttributeFromSplitLocator, _getInnerElement, _hideAddressBar, _hideAddressBarNow, _insert, _isDifferent, _isHDPIDisplay, _isIOS4OrOlder, _isIOS5, _isIOSMin6_0, _isStandaloneMode, _nativeParseFloat, _removeClassName, _setClassName, _setHandleDisabled, _sinkAnimationEndEvent, _sinkContentChangedEvent, _sinkFocusInEvent, _sinkFocusOutEvent, _sinkInputEvent, _sinkRequestScrollToEvent, _sinkTransitionEndEvent, _triggerDebugger, addChild, addChild, addChild, addClickHandler, addShowContextMenuHandler, destroy, disable, enable, getContextMenu, getID, getInnerHTML, getMargin, hasChild, hasChild, isAndroid, isDisabled, isEnabled, isIPad, isIPhone, isSafari, isStandAlone, isUIWebView, onBrowserEvent, parseDimension, removeChild, removeChild, setContents, setContextMenu, setDisabled, setElement, setID, setMargin, setStyleName, split, useIOSNativeScrolling

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel
add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel
add, add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - alignment
```
protected Alignment alignment
```
  - enforcePolicy
```
protected java.lang.Boolean enforcePolicy
```
  - hPolicy
```
protected LayoutPolicy hPolicy
```
  - members
```
protected java.util.List<Canvas> members
```
  - membersMargin
```
protected int membersMargin
```
  - minMemberSize
```
protected int minMemberSize
```
  - momentumScroll
```
protected boolean momentumScroll
```
  - overflow
```
protected Overflow overflow
```
  - paddingAsLayoutMargin
```
protected boolean paddingAsLayoutMargin
```
  - reverseOrder
```
protected java.lang.Boolean reverseOrder
```
  - valign
```
protected VerticalAlignment valign
```
  - vertical
```
protected java.lang.Boolean vertical
```
- Constructor Detail
  - Layout
```
public Layout()
```
- Method Detail
  - setEnforcePolicy
```
public void setEnforcePolicy(java.lang.Boolean enforcePolicy)
```
    Whether the layout policy is continuously enforced as new members are added or removed and as members are resized.
    This setting implies that any member that resizes larger, or any added member, will take space from other members in order to allow the overall layout to stay the same size.
    Note : This is an advanced setting
    
    Parameters:
    
    enforcePolicy - enforcePolicy Default value is true
  - getEnforcePolicy
```
public java.lang.Boolean getEnforcePolicy()
```
    Whether the layout policy is continuously enforced as new members are added or removed and as members are resized.
    This setting implies that any member that resizes larger, or any added member, will take space from other members in order to allow the overall layout to stay the same size.
    
    Returns:
    
    Boolean
  - setHPolicy
```
public void setHPolicy(LayoutPolicy hPolicy)
```
    Sizing policy applied to members on horizontal axis
    Note : This is an advanced setting
    
    Parameters:
    
    hPolicy - hPolicy Default value is "fill"
  - getHPolicy
```
public LayoutPolicy getHPolicy()
```
    Sizing policy applied to members on horizontal axis
    
    Returns:
    
    LayoutPolicy
  - setLayoutBottomMargin
```
public void setLayoutBottomMargin(java.lang.Integer layoutBottomMargin)
```
    Space outside of all members, on the bottom side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Parameters:
    
    layoutBottomMargin - layoutBottomMargin Default value is null
  - getLayoutBottomMargin
```
public java.lang.Integer getLayoutBottomMargin()
```
    Space outside of all members, on the bottom side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Returns:
    
    Integer
  - setLayoutLeftMargin
```
public void setLayoutLeftMargin(java.lang.Integer layoutLeftMargin)
```
    Space outside of all members, on the left-hand side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Parameters:
    
    layoutLeftMargin - layoutLeftMargin Default value is null
  - getLayoutLeftMargin
```
public java.lang.Integer getLayoutLeftMargin()
```
    Space outside of all members, on the left-hand side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Returns:
    
    Integer
  - setLayoutMargin
```
public void setLayoutMargin(java.lang.Integer layoutMargin)
```
    Space outside of all members. This attribute, along with layoutLeftMargin and related properties does not have a true setter method.
    It may be assigned directly at runtime. After setting the property, Layout.setLayoutMargin may be called with no arguments to reflow the layout. Method to force a reflow of the layout after directly assigning a value to any of the layout*Margin properties. Takes no arguments.
    
    Parameters:
    
    layoutMargin - layoutMargin Default value is null
    
    See Also:
    
    setLayoutLeftMargin(java.lang.Integer), setLayoutRightMargin(java.lang.Integer), setLayoutBottomMargin(java.lang.Integer), setLayoutTopMargin(java.lang.Integer), setPaddingAsLayoutMargin(java.lang.Boolean), User Sizing Example
  - getLayoutMargin
```
public java.lang.Integer getLayoutMargin()
```
    Space outside of all members. This attribute, along with layoutLeftMargin and related properties does not have a true setter method.
    It may be assigned directly at runtime. After setting the property, Layout.setLayoutMargin may be called with no arguments to reflow the layout.
    
    Returns:
    
    Integer
    
    See Also:
    
    getLayoutLeftMargin(), getLayoutRightMargin(), getLayoutBottomMargin(), getLayoutTopMargin(), getPaddingAsLayoutMargin(), User Sizing Example
  - setLayoutRightMargin
```
public void setLayoutRightMargin(java.lang.Integer layoutRightMargin)
```
    Space outside of all members, on the right-hand side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Parameters:
    
    layoutRightMargin - layoutRightMargin Default value is null
  - getLayoutRightMargin
```
public java.lang.Integer getLayoutRightMargin()
```
    Space outside of all members, on the right-hand side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Returns:
    
    Integer
  - setLayoutTopMargin
```
public void setLayoutTopMargin(java.lang.Integer layoutTopMargin)
```
    Space outside of all members, on the top side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Parameters:
    
    layoutTopMargin - layoutTopMargin Default value is null
  - getLayoutTopMargin
```
public java.lang.Integer getLayoutTopMargin()
```
    Space outside of all members, on the top side. Defaults to layoutMargin.
    Requires a manual call to setLayoutMargin() if changed on the fly.
    
    Returns:
    
    Integer
  - setManagePercentBreadth
```
public void setManagePercentBreadth(java.lang.Boolean managePercentBreadth)
                             throws java.lang.IllegalStateException
```
    If set, a Layout with breadthPolicy:"fill" will specially interpret a percentage breadth on a member as a percentage of available space excluding the layoutMargin. If false, percentages work exactly as for a non-member, with layoutMargins, if any, ignored.
    
    Parameters:
    
    managePercentBreadth - managePercentBreadth Default value is true
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getManagePercentBreadth
```
public java.lang.Boolean getManagePercentBreadth()
```
    If set, a Layout with breadthPolicy:"fill" will specially interpret a percentage breadth on a member as a percentage of available space excluding the layoutMargin. If false, percentages work exactly as for a non-member, with layoutMargins, if any, ignored.
    
    Returns:
    
    Boolean
  - setMembersMargin
```
public void setMembersMargin(int membersMargin)
```
    Space between each member of the layout.
    Requires a manual call to reflow() if changed on the fly.
    
    Parameters:
    
    membersMargin - membersMargin Default value is 0
  - getMembersMargin
```
public int getMembersMargin()
```
    Space between each member of the layout.
    Requires a manual call to reflow() if changed on the fly.
    
    Returns:
    
    int
  - setMinMemberSize
```
public void setMinMemberSize(int minMemberSize)
```
    Minimum size, in pixels, below which members should never be shrunk, even if this requires the Layout to overflow.
    
    Parameters:
    
    minMemberSize - minMemberSize Default value is 1
  - getMinMemberSize
```
public int getMinMemberSize()
```
    Minimum size, in pixels, below which members should never be shrunk, even if this requires the Layout to overflow.
    
    Returns:
    
    int
  - setOverflow
```
public void setOverflow(Overflow overflow)
                 throws java.lang.IllegalStateException
```
    Normal Overflow settings can be used on layouts, for example, an overflow:auto Layout will scroll if members exceed its specified size, whereas an overflow:visible Layout will grow to accommodate members.
    
    Parameters:
    
    overflow - overflow Default value is "visible"
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - getOverflow
```
public Overflow getOverflow()
```
    Normal Overflow settings can be used on layouts, for example, an overflow:auto Layout will scroll if members exceed its specified size, whereas an overflow:visible Layout will grow to accommodate members.
    
    Returns:
    
    Overflow
  - setPaddingAsLayoutMargin
```
public void setPaddingAsLayoutMargin(java.lang.Boolean paddingAsLayoutMargin)
```
    If this widget has padding specified (or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
    If this setting is false, padding will not affect member positioning (as CSS padding normally does not affect absolutely positioned children). Leaving this setting true allows a designer to more effectively control layout purely from CSS.
    Note : This is an advanced setting
    
    Parameters:
    
    paddingAsLayoutMargin - paddingAsLayoutMargin Default value is true
  - getPaddingAsLayoutMargin
```
public java.lang.Boolean getPaddingAsLayoutMargin()
```
    If this widget has padding specified or in the CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin?
    If this setting is false, padding will not affect member positioning (as CSS padding normally does not affect absolutely positioned children). Leaving this setting true allows a designer to more effectively control layout purely from CSS.
    Note that layoutMargin if specified, takes precedence over this value.
    
    Returns:
    
    Boolean
  - setReverseOrder
```
public void setReverseOrder(java.lang.Boolean reverseOrder)
```
    Reverse the order of stacking for this Layout, so that the last member is shown first.
    Requires a manual call to reflow() if changed on the fly.
    In RTL mode, for horizontal Layouts the value of this flag will be flipped during initialization.
    
    Parameters:
    
    reverseOrder - reverseOrder Default value is false
  - getReverseOrder
```
public java.lang.Boolean getReverseOrder()
```
    Reverse the order of stacking for this Layout, so that the last member is shown first.
    Requires a manual call to reflow() if changed on the fly.
    In RTL mode, for horizontal Layouts the value of this flag will be flipped during initialization.
    
    Returns:
    
    Boolean
  - setVertical
```
public void setVertical(java.lang.Boolean vertical)
```
    Should this layout appear with members stacked vertically or horizontally. Defaults to false if unspecified.
    
    Parameters:
    
    vertical - vertical Default value is null
  - getVertical
```
public java.lang.Boolean getVertical()
```
    Should this layout appear with members stacked vertically or horizontally. Defaults to false if unspecified.
    
    Returns:
    
    Boolean
  - setVPolicy
```
public void setVPolicy(LayoutPolicy vPolicy)
```
    Sizing policy applied to members on vertical axis
    Note : This is an advanced setting
    
    Parameters:
    
    vPolicy - vPolicy Default value is "fill"
  - getVPolicy
```
public LayoutPolicy getVPolicy()
```
    Sizing policy applied to members on vertical axis
    
    Returns:
    
    LayoutPolicy
  - hasMember
```
public java.lang.Boolean hasMember(Canvas canvas)
```
    Returns true if the layout includes the specified canvas.
    
    Parameters:
    
    canvas - the canvas to check for
    
    Returns:
    
    true if the layout includes the specified canvas
  - reflow
```
public void reflow()
```
    Layout members according to current settings.
    Members will reflow automatically when the layout is resized, members resize, the list of members changes or members change visibility. It is only necessary to manually call reflow() after changing settings on the layout, for example, layout.reverseOrder.
  - removeMember
```
public void removeMember(Canvas member)
```
    Removes the specified member from the layout. If it has a resize bar, the bar will be destroyed.
    
    Parameters:
    
    member - the canvas to be removed from the layout
  - removeMember
```
public void removeMember(com.google.gwt.user.client.ui.Widget widget)
```
  - removeMembers
```
public void removeMembers(Canvas... members)
```
  - removeMembers
```
public void removeMembers(java.lang.Iterable<? extends Canvas> iterable)
```
  - reorderMember
```
public void reorderMember(int memberNum,
                          int newPosition)
```
    Shift a member of the layout to a new position
    
    Parameters:
    
    memberNum - current position of the member to move to a new position
    
    newPosition - new position to move the member to
  - reorderMembers
```
public void reorderMembers(int start,
                           int end,
                           int newPosition)
```
    Move a range of members to a new position
    
    Parameters:
    
    start - beginning of range of members to move
    
    end - end of range of members to move, non-inclusive
    
    newPosition - new position to move the members to
  - setVisibleMember
```
public void setVisibleMember(Canvas member)
```
    Hide all other members and make the single parameter member visible.
    
    Parameters:
    
    member - member to show
  - setMembers
```
public void setMembers(Canvas... members)
```
    An array of canvases that will be contained within this layout. You can set the following properties on these canvases (in addition to the standard component properties):
    - layoutAlign--specifies the member's alignment along the breadth axis; valid values are "top", "center" and "bottom" for a horizontal layout and "left", "center" and "right" for a vertical layout
    - showResizeBar--set to true to show a resize bar (default is false)
    Height and width settings found on members are interpreted by the Layout according to the getVPolicy
    Parameters:
    
    members - members Default value is null
  - addMembers
```
public void addMembers(Canvas... members)
```
    Add one or more canvases to the layout
    
    Parameters:
    
    members - - canvases to be added
  - addMembers
```
public void addMembers(Canvas[] members,
                       int position)
```
    Add one or more canvases to the layout at specific positions.
    
    Parameters:
    
    members - - array of canvases to be added
    
    position - - position to add newMembers
  - addMembers
```
public void addMembers(java.lang.Iterable<? extends Canvas> members,
                       int position)
```
  - addMember
```
public void addMember(Canvas component)
```
    Add a canvas to the layout.
    
    Parameters:
    
    component - the canvas object to be added to the layout
  - addMember
```
public void addMember(com.google.gwt.user.client.ui.Widget widget)
```
  - addMember
```
public void addMember(Canvas component,
                      int position)
```
    Adds a component to the layout at the specified position.
    
    Parameters:
    
    component - the Canvas object to be added to the layout
    
    position - the position in the layout at which to place component (starts with 0)
  - addMember
```
public void addMember(com.google.gwt.user.client.ui.Widget widget,
                      int position)
```
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface com.google.gwt.user.client.ui.HasWidgets
    
    Overrides:
    
    clear in class com.google.gwt.user.client.ui.Panel
  - setDefaultLayoutAlign
```
public void setDefaultLayoutAlign(Alignment alignment)
                           throws java.lang.IllegalStateException
```
    Specifies the default alignment for layout members on the breadth axis. If unset, default member layout alignment will be "top" for a horizontal layout, and left for a vertical layout.
    
    Parameters:
    
    alignment - defaultLayoutAlign Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - setDefaultLayoutAlign
```
public void setDefaultLayoutAlign(VerticalAlignment alignment)
                           throws java.lang.IllegalStateException
```
    Specifies the default alignment for layout members on the breadth axis. If unset, default member layout alignment will be "top" for a horizontal layout, and left for a vertical layout.
    
    Parameters:
    
    alignment - defaultLayoutAlign Default value is null
    
    Throws:
    
    java.lang.IllegalStateException - this property cannot be changed after the component has been created
  - setAlign
```
public void setAlign(Alignment alignment)
```
    Alignment of all members in this Layout on the length axis. Defaults to "top" for vertical Layouts, and "left" for horizontal Layouts.
    
    Parameters:
    
    alignment - alignment Default value is null
  - setAlign
```
public void setAlign(VerticalAlignment valign)
```
    Alignment of all members in this Layout on the length axis. Defaults to "top" for vertical Layouts, and "left" for horizontal Layouts.
    
    Parameters:
    
    valign - alignment Default value is null
  - getMembers
```
public Canvas[] getMembers()
```
    Return the members in the Layout.
    
    Returns:
    
    the members
  - getMomentumScroll
```
public boolean getMomentumScroll()
```
    Return if momentum scroll is enabled.
    
    Returns:
    
    boolean
  - setMomentumScroll
```
public void setMomentumScroll(boolean onoff)
```
    Enable/disable momentum scroll
  - showMember
```
public final void showMember(Canvas member)
```
    Show the specified member, firing the specified callback when the hide is complete.
    Members can always be directly shown via member.show()
    
    Parameters:
    
    member - Member to show
  - showMember
```
public final void showMember(Canvas member,
                             Function callback)
```
    Show the specified member, firing the specified callback when show is complete.
    Members can always be directly shown via member.show()
    
    Parameters:
    
    member - Member to show
    
    callback - action to fire when the member has been shown
  - hideMember
```
public final void hideMember(Canvas member)
```
    Hide the specified member, firing the specified callback when the hide is complete.
    Members can always be directly hidden via member.hide()
    
    Parameters:
    
    member - Member to hide
  - hideMember
```
public final void hideMember(Canvas member,
                             Function callback)
```
    Hide the specified member, firing the specified callback when the hide is complete.
    Members can always be directly hidden via member.hide()
    
    Parameters:
    
    member - Member to hide
    
    callback - callback to fire when the member is hidden.
  - getMember
```
public Canvas getMember(int index)
```
    Given a numerical index or a member ID, return a pointer to the appropriate member.
    If passed a member Canvas, just returns it.
    
    Parameters:
    
    index - index for the member
    
    Returns:
    
    member widget
  - getMember
```
public Canvas getMember(java.lang.String memberID)
```
    Given a numerical index or a member ID, return a pointer to the appropriate member.
    If passed a member Canvas, just returns it.
    
    Parameters:
    
    memberID - identifier for the required member
    
    Returns:
    
    member widget
  - getMemberNumber
```
public int getMemberNumber(Canvas member)
```
    Given a member Canvas or member ID, return the index of that member within this layout's members array
    If passed a number, just returns it.
    
    Parameters:
    
    member - the member
    
    Returns:
    
    index of the member canvas (or -1 if not found)
  - getMemberNumber
```
public int getMemberNumber(java.lang.String memberID)
```
    Given a member Canvas or member ID, return the index of that member within this layout's members array
    If passed a number, just returns it.
    
    Parameters:
    
    memberID - identifier for the required member
    
    Returns:
    
    index of the member canvas (or -1 if not found)
  - addDragMoveHandler
```
public com.google.gwt.event.shared.HandlerRegistration addDragMoveHandler(DragMoveHandler dragMoveHandler)
```
    Description copied from interface: HasDragMoveHandlers
    
    Executed every time the mouse moves while dragging this canvas.
    
    Specified by:
    
    addDragMoveHandler in interface HasDragMoveHandlers
    
    Parameters:
    
    dragMoveHandler - the dragMove handler
    
    Returns:
    
    HandlerRegistration used to remove this handler

Class Layout

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

Field Summary

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas

Fields inherited from class com.google.gwt.user.client.ui.UIObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

Methods inherited from class com.google.gwt.user.client.ui.Panel

Methods inherited from class com.google.gwt.user.client.ui.Widget

Methods inherited from class com.google.gwt.user.client.ui.UIObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

Methods inherited from interface java.lang.Iterable

Field Detail

alignment

enforcePolicy

hPolicy

members

membersMargin

minMemberSize

momentumScroll

overflow

paddingAsLayoutMargin

reverseOrder

valign

vertical

Constructor Detail

Layout

Method Detail

setEnforcePolicy

getEnforcePolicy

setHPolicy

getHPolicy

setLayoutBottomMargin

getLayoutBottomMargin

setLayoutLeftMargin

getLayoutLeftMargin

setLayoutMargin

getLayoutMargin

setLayoutRightMargin

getLayoutRightMargin

setLayoutTopMargin

getLayoutTopMargin

setManagePercentBreadth

getManagePercentBreadth

setMembersMargin

getMembersMargin

setMinMemberSize

getMinMemberSize

setOverflow

getOverflow

setPaddingAsLayoutMargin

getPaddingAsLayoutMargin

setReverseOrder

getReverseOrder

setVertical

getVertical

setVPolicy

getVPolicy

hasMember

reflow

removeMember

removeMember

removeMembers

removeMembers

reorderMember

reorderMembers

setVisibleMember

setMembers

addMembers

addMembers

addMembers

addMember

addMember

addMember