public class Layout extends Canvas implements HasMembersChangedHandlers
A Layout manages a set of "member" Canvases provided as members
. Layouts can have both "members", whose position and size
are managed by the Layout, and normal Canvas children, which manage their own position and size.
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.
Since Layouts can be either horizontally or vertically oriented, throughout the documentation of Layout and it's subclasses, the term "length" refers to the axis of stacking, and the term "breadth" refers to the other axis. Hence, "length" means height in the context of a VLayout or VStack, but means width in the context of an HLayout or HStack.
To show a resizer bar after
(to the right or bottom of) a layout member, set showResizeBar
to true on that member component (not on the HLayout or VLayout). Resizer bars override membersMargin
spacing.
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%".
LayoutPolicy
,
VLayout
,
HLayout
,
VStack
,
HStack
,
LayoutSpacer
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
Layout() |
Layout(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
void |
addMember(Canvas component)
Add a canvas to the layout, optionally at a specific position.
|
void |
addMember(Canvas component,
int position)
Add a canvas to the layout, optionally at a specific position.
|
void |
addMember(com.google.gwt.user.client.ui.Widget widget)
Add a canvas to the layout, optionally at a specific position.
|
void |
addMember(com.google.gwt.user.client.ui.Widget widget,
int position) |
protected void |
addMemberPostCreate(java.lang.Object componentJS) |
protected void |
addMemberPostCreate(java.lang.Object componentJS,
int position) |
protected void |
addMemberPreCreate(java.lang.Object componentJS) |
protected void |
addMemberPreCreate(java.lang.Object componentJS,
int position) |
void |
addMembers(Canvas... newMembers)
Add one or more canvases to the layout.
|
void |
addMembers(Canvas[] newMembers,
int position)
Add one or more canvases to the layout at specific positions.
|
com.google.gwt.event.shared.HandlerRegistration |
addMembersChangedHandler(MembersChangedHandler handler)
Add a membersChanged handler.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.Boolean |
getAnimateMembers()
If true when members are added / removed, they should be animated as they are shown or hidden in position
|
java.lang.Integer |
getAnimateMemberTime()
If specified this is the duration of show/hide animations when members are being shown or hidden due to being added /
removed from this layout.
|
java.lang.Boolean |
getCanDropComponents()
Layouts provide a default implementation of a drag and drop interaction.
|
java.lang.Integer |
getChildTabPosition(Canvas child)
Layouts ensure children are ordered in the tab-sequence with members being reachable first (in member order), then any
non-member children.
|
LayoutResizeBarPolicy |
getDefaultResizeBars()
Policy for whether resize bars are shown on members by default.
|
protected Canvas |
getDropComponent(Canvas dragTarget,
int dropPosition) |
Canvas |
getDropLine()
Line showed to mark the drop position when components are being dragged onto this Layout.
|
int |
getDropLineThickness()
Thickness, in pixels of the dropLine shown during drag and drop when
canDropComponents is set to true . |
int |
getDropPosition()
Get the position a new member would be dropped.
|
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
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 |
getLayoutEndMargin()
Equivalent to
layoutRightMargin for a horizontal
layout, or layoutBottomMargin for a vertical
layout. |
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 |
getLayoutStartMargin()
Equivalent to
layoutLeftMargin for a horizontal
layout, or layoutTopMargin for a vertical layout. |
java.lang.Integer |
getLayoutTopMargin()
Space outside of all members, on the top side.
|
java.lang.Boolean |
getLeaveScrollbarGap()
Whether to leave a gap for a vertical scrollbar even when one is not actually present.
|
LocatorStrategy |
getLocateMembersBy()
Part of the
AutomatedTesting system, strategy to use when generated locators for
members from within this Layout's members array. |
LocatorTypeStrategy |
getLocateMembersType()
LocatorTypeStrategy to use when finding members within this layout. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
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)
|
void |
getMemberDefaultBreadth(Canvas member,
int defaultBreadth)
Return the breadth for a member of this layout which either didn't specify a breadth or specified a percent breadth with
managePercentBreadth :true. |
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)
|
int |
getMemberOverlap()
Number of pixels by which each member should overlap the preceding member, used for creating an "stack of cards"
appearance for the members of a Layout.
|
Canvas[] |
getMembers()
An array of canvases that will be contained within this layout.
|
java.lang.Integer |
getMembersLength()
Convenience method to return the number of members this Layout has
|
int |
getMembersMargin()
Space between each member of the layout.
|
int |
getMinMemberLength()
Minimum size, in pixels, below which flexible-sized members should never be shrunk, even if this requires the Layout to
overflow.
|
int |
getMinMemberSize()
Deprecated.
use the more intuitively named
minMemberLength |
static Layout |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
Overflow |
getOverflow()
A Layout may overflow if it has one or more members with a fixed width or height, or that themselves overflow.
|
java.lang.Boolean |
getPaddingAsLayoutMargin()
If this widget has padding specified (as
this.padding or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin? |
Splitbar |
getResizeBar()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getResizeBarClass()
Default class to use for creating
resizeBars . |
int |
getResizeBarSize()
Thickness of the resizeBar in pixels.
|
java.lang.Boolean |
getReverseOrder()
Reverse the order of stacking for this Layout, so that the last member is shown first.
|
java.lang.Boolean |
getShowDragPlaceHolder()
If set to true, when a member is dragged out of layout, a visible placeholder canvas will be displayed in place of the
dragged widget for the duration of the drag and drop interaction.
|
java.lang.Boolean |
getShowDropLines()
Controls whether to show a drop-indicator during a drag and drop operation.
|
java.lang.String |
getStackZIndex()
For use in conjunction with
memberOverlap , controls
the z-stacking order of members. |
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 |
hideDropLine()
Calling this method hides the dropLine shown during a drag and drop interaction with a Layout that has
canDropComponents set to true. |
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.
|
boolean |
layoutIsDirty()
Returns whether there is a pending reflow of the members of the layout.
|
protected void |
onInit_Layout() |
protected void |
onInit() |
void |
reflow()
Layout members according to current settings.
|
void |
reflow(java.lang.String reason)
Layout members according to current settings.
|
void |
reflowNow()
Layout members according to current settings, immediately.
|
void |
removeMember(Canvas member)
Removes the specified member from the layout.
|
void |
removeMembers(Canvas... members)
Removes the specified members from the layout.
|
void |
removeMembers(Canvas members)
Removes the specified members from the layout.
|
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 |
replaceMember(Canvas oldMember,
Canvas newMember)
Replaces an existing member of the layout with a different widget.
|
void |
revealChild(Canvas child)
Reveals the child or member Canvas passed in by showing it if it is currently hidden
NOTE: This is an override point.
|
void |
revealChild(java.lang.String childID)
Reveals the child or member Canvas passed in by showing it if it is currently hidden.
|
Layout |
setAlign(Alignment alignment)
Alignment of all members in this Layout on the length axis.
|
void |
setAlign(VerticalAlignment alignment)
Alignment of all members in this Layout on the length axis.
|
Layout |
setAnimateMembers(java.lang.Boolean animateMembers)
If true when members are added / removed, they should be animated as they are shown or hidden in position
|
Layout |
setAnimateMemberTime(java.lang.Integer animateMemberTime)
If specified this is the duration of show/hide animations when members are being shown or hidden due to being added /
removed from this layout.
|
Layout |
setCanDropComponents(java.lang.Boolean canDropComponents)
Layouts provide a default implementation of a drag and drop interaction.
|
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.
|
static void |
setDefaultProperties(Layout layoutProperties)
Class level method to set the default properties of this class.
|
Layout |
setDefaultResizeBars(LayoutResizeBarPolicy defaultResizeBars)
Policy for whether resize bars are shown on members by default.
|
void |
setDropLineProperties(Canvas dropLineProperties) |
Layout |
setDropLineThickness(int dropLineThickness)
Thickness, in pixels of the dropLine shown during drag and drop when
canDropComponents is set to true . |
Layout |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
Layout |
setEnforcePolicy(java.lang.Boolean enforcePolicy)
Whether the layout policy is continuously enforced as new members are added or removed and as members are resized.
|
Layout |
setHPolicy(LayoutPolicy hPolicy)
Sizing policy applied to members on horizontal axis
|
Layout |
setLayoutBottomMargin(java.lang.Integer layoutBottomMargin)
Space outside of all members, on the bottom side.
|
Layout |
setLayoutEndMargin(java.lang.Integer layoutEndMargin)
Equivalent to
layoutRightMargin for a horizontal
layout, or layoutBottomMargin for a vertical
layout. |
Layout |
setLayoutLeftMargin(java.lang.Integer layoutLeftMargin)
Space outside of all members, on the left-hand side.
|
Layout |
setLayoutMargin(java.lang.Integer layoutMargin)
Space outside of all members.
|
Layout |
setLayoutRightMargin(java.lang.Integer layoutRightMargin)
Space outside of all members, on the right-hand side.
|
Layout |
setLayoutStartMargin(java.lang.Integer layoutStartMargin)
Equivalent to
layoutLeftMargin for a horizontal
layout, or layoutTopMargin for a vertical layout. |
Layout |
setLayoutTopMargin(java.lang.Integer layoutTopMargin)
Space outside of all members, on the top side.
|
Layout |
setLeaveScrollbarGap(java.lang.Boolean leaveScrollbarGap)
Whether to leave a gap for a vertical scrollbar even when one is not actually present.
|
Layout |
setLocateMembersBy(LocatorStrategy locateMembersBy)
Part of the
AutomatedTesting system, strategy to use when generated locators for
members from within this Layout's members array. |
Layout |
setLocateMembersType(LocatorTypeStrategy locateMembersType)
LocatorTypeStrategy to use when finding members within this layout. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.LayoutLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
Layout |
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 . |
Layout |
setMemberOverlap(int memberOverlap)
Number of pixels by which each member should overlap the preceding member, used for creating an "stack of cards"
appearance for the members of a Layout.
|
Layout |
setMembers(Canvas... members)
An array of canvases that will be contained within this layout.
|
Layout |
setMembersMargin(int membersMargin)
Space between each member of the layout.
|
Layout |
setMinBreadthMember(Canvas minBreadthMember)
Set this property to cause the layout to assign the breadths of other members as if the available breadth is actually
wide enough to accommodate the
minBreadthMember (even though the Layout might not actually be that
wide, and may overflow its assigned size along the breadth axis due to the breadth of the minBreadthMember . |
Layout |
setMinBreadthMember(int minBreadthMember)
Set this property to cause the layout to assign the breadths of other members as if the available breadth is actually
wide enough to accommodate the
minBreadthMember (even though the Layout might not actually be that
wide, and may overflow its assigned size along the breadth axis due to the breadth of the minBreadthMember . |
Layout |
setMinBreadthMember(java.lang.String minBreadthMember)
Set this property to cause the layout to assign the breadths of other members as if the available breadth is actually
wide enough to accommodate the
minBreadthMember (even though the Layout might not actually be that
wide, and may overflow its assigned size along the breadth axis due to the breadth of the minBreadthMember . |
Layout |
setMinMemberLength(int minMemberLength)
Minimum size, in pixels, below which flexible-sized members should never be shrunk, even if this requires the Layout to
overflow.
|
Layout |
setMinMemberSize(int minMemberSize)
Deprecated.
use the more intuitively named
minMemberLength |
Layout |
setOverflow(Overflow overflow)
A Layout may overflow if it has one or more members with a fixed width or height, or that themselves overflow.
|
Layout |
setPaddingAsLayoutMargin(java.lang.Boolean paddingAsLayoutMargin)
If this widget has padding specified (as
this.padding or in the
CSS style applied to this layout), should it show up as space outside the members, similar to layoutMargin? |
Layout |
setPlaceHolderDefaults(Canvas placeHolderDefaults)
If
this.showDragPlaceHolder is true, this
defaults object determines the default appearance of the placeholder displayed when the user drags a widget out of this
layout.Default value for this property sets the placeholder styleName to "layoutPlaceHolder" To modify this object, use Class.changeDefaults() |
Layout |
setPlaceHolderProperties(Canvas placeHolderProperties)
If
this.showDragPlaceHolder is true, this
properties object can be used to customize the appearance of the placeholder displayed when the user drags a widget out
of this layout. |
Layout |
setResizeBarClass(java.lang.String resizeBarClass)
Default class to use for creating
resizeBars . |
Layout |
setResizeBarSize(int resizeBarSize)
Thickness of the resizeBar in pixels.
|
Layout |
setReverseOrder(java.lang.Boolean reverseOrder)
Reverse the order of stacking for this Layout, so that the last member is shown first.
|
Layout |
setShowDragPlaceHolder(java.lang.Boolean showDragPlaceHolder)
If set to true, when a member is dragged out of layout, a visible placeholder canvas will be displayed in place of the
dragged widget for the duration of the drag and drop interaction.
|
Layout |
setShowDropLines(java.lang.Boolean showDropLines)
Controls whether to show a drop-indicator during a drag and drop operation.
|
Layout |
setStackZIndex(java.lang.String stackZIndex)
For use in conjunction with
memberOverlap , controls
the z-stacking order of members. |
Layout |
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.
|
Layout |
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 show is complete.
|
void |
showMember(Canvas member,
Function callback)
Show the specified member, firing the specified callback when the show is complete.
|
addChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
public Layout()
public Layout(com.google.gwt.core.client.JavaScriptObject jsObj)
public static Layout getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public Layout setAnimateMembers(java.lang.Boolean animateMembers)
animateMembers
- New animateMembers value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Boolean getAnimateMembers()
public Layout setAnimateMemberTime(java.lang.Integer animateMemberTime)
Note : This is an advanced setting
animateMemberTime
- New animateMemberTime value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Integer getAnimateMemberTime()
public Layout setCanDropComponents(java.lang.Boolean canDropComponents) throws java.lang.IllegalStateException
canAcceptDrop
:true and canDropComponents:true
on a Layout, when a droppable Canvas (canDrop:true
is dragged over
the layout, it will show a dropLine (a simple insertion line) at the drop location.
When the drop occurs, the dragTarget (obtained using
EventHandler.getDragTarget()
) is added as a member of this
layout at the location
shown by the dropLine (calculated by getDropPosition()
). This default
behavior allows either members or external components that have
Canvas.canDragReposition
(or Canvas.canDrag
) and Canvas.canDrop
set
to true
to be added to or reordered within the Layout.
You can control the thickness of the dropLine via dropLineThickness
and
you can customize the style using css styling in the skin file (look for .layoutDropLine
in skin_styles.css for your skin).
If you want to dynamically create a component to be added to the Layout in response to a drop event you can do so as follows:
final VLayout vLayout = new VLayout(); //...various layout properties... vLayout.setCanDropComponents(true); vLayout.addDropHandler(new DropHandler() { @Override public void onDrop(DropEvent event) { // create the new component Canvas newMember = new Canvas(); // add to the layout at the current drop position // (the dropLine will be showing here) vLayout.addMember(newMember, vLayout.getDropPosition()); // hide the dropLine that was automatically shown // by builtin SmartGWT methods vLayout.hideDropLine(); } });If you want to completely suppress the builtin drag and drop logic, but still receive drag and drop events for your own custom implementation, set
Canvas.canAcceptDrop
to
true
and canDropComponents
to false
on your Layout.
Note : This is an advanced setting
canDropComponents
- New canDropComponents value. Default value is trueLayout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDragdrop overview and related methods
public java.lang.Boolean getCanDropComponents()
canAcceptDrop
:true and canDropComponents:true
on a Layout, when a droppable Canvas (canDrop:true
is dragged over
the layout, it will show a dropLine (a simple insertion line) at the drop location.
When the drop occurs, the dragTarget (obtained using
EventHandler.getDragTarget()
) is added as a member of this
layout at the location
shown by the dropLine (calculated by getDropPosition()
). This default
behavior allows either members or external components that have
Canvas.canDragReposition
(or Canvas.canDrag
) and Canvas.canDrop
set
to true
to be added to or reordered within the Layout.
You can control the thickness of the dropLine via dropLineThickness
and
you can customize the style using css styling in the skin file (look for .layoutDropLine
in skin_styles.css for your skin).
If you want to dynamically create a component to be added to the Layout in response to a drop event you can do so as follows:
final VLayout vLayout = new VLayout(); //...various layout properties... vLayout.setCanDropComponents(true); vLayout.addDropHandler(new DropHandler() { @Override public void onDrop(DropEvent event) { // create the new component Canvas newMember = new Canvas(); // add to the layout at the current drop position // (the dropLine will be showing here) vLayout.addMember(newMember, vLayout.getDropPosition()); // hide the dropLine that was automatically shown // by builtin SmartGWT methods vLayout.hideDropLine(); } });If you want to completely suppress the builtin drag and drop logic, but still receive drag and drop events for your own custom implementation, set
Canvas.canAcceptDrop
to
true
and canDropComponents
to false
on your Layout.Dragdrop overview and related methods
public Layout setDefaultResizeBars(LayoutResizeBarPolicy defaultResizeBars)
Canvas.showResizeBar
for members of this layout.defaultResizeBars
- New defaultResizeBars value. Default value is "marked"Layout
instance, for chaining setter callsCanvas.setShowResizeBar(java.lang.Boolean)
public LayoutResizeBarPolicy getDefaultResizeBars()
Canvas.showResizeBar
for members of this layout.Canvas.getShowResizeBar()
public Canvas getDropLine() throws java.lang.IllegalStateException
This component is an AutoChild named "dropLine". For an overview of how to use and
configure AutoChildren, see Using AutoChildren
.
java.lang.IllegalStateException
- if this widget has not yet been rendered.public Layout setDropLineThickness(int dropLineThickness) throws java.lang.IllegalStateException
canDropComponents
is set to true
. See the
discussion in Layout
for more info.
Note : This is an advanced setting
dropLineThickness
- New dropLineThickness value. Default value is 2Layout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdLayout
,
Dragdrop overview and related methods
,
Drag move Examplepublic int getDropLineThickness()
canDropComponents
is set to true
. See the
discussion in Layout
for more info.Layout
,
Dragdrop overview and related methods
,
Drag move Examplepublic Layout setEditProxyConstructor(java.lang.String editProxyConstructor) throws java.lang.IllegalStateException
EditProxy
for this component when the component is
first placed into edit mode
.setEditProxyConstructor
in class Canvas
editProxyConstructor
- New editProxyConstructor value. Default value is "LayoutEditProxy"Layout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCClassName
public java.lang.String getEditProxyConstructor()
EditProxy
for this component when the component is
first placed into edit mode
.getEditProxyConstructor
in class Canvas
SCClassName
public Layout setEnforcePolicy(java.lang.Boolean enforcePolicy)
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
enforcePolicy
- New enforcePolicy value. Default value is trueLayout
instance, for chaining setter callspublic java.lang.Boolean getEnforcePolicy()
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.
public Layout setHPolicy(LayoutPolicy hPolicy)
Note : This is an advanced setting
hPolicy
- New hPolicy value. Default value is "fill"Layout
instance, for chaining setter callspublic LayoutPolicy getHPolicy()
public Layout setLayoutBottomMargin(java.lang.Integer layoutBottomMargin)
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
layoutBottomMargin
- New layoutBottomMargin value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Integer getLayoutBottomMargin()
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
public Layout setLayoutEndMargin(java.lang.Integer layoutEndMargin)
layoutRightMargin
for a horizontal
layout, or layoutBottomMargin
for a vertical
layout. If both layoutEndMargin
and the more specific properties (right/bottom margin) are both set,
the more specific properties win.
layoutEndMargin
- New layoutEndMargin value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Integer getLayoutEndMargin()
layoutRightMargin
for a horizontal
layout, or layoutBottomMargin
for a vertical
layout. If both layoutEndMargin
and the more specific properties (right/bottom margin) are both set,
the more specific properties win.
public Layout setLayoutLeftMargin(java.lang.Integer layoutLeftMargin)
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
layoutLeftMargin
- New layoutLeftMargin value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Integer getLayoutLeftMargin()
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
public Layout setLayoutMargin(java.lang.Integer layoutMargin)
layoutLeftMargin
and related properties do not have a
true setter method. If this method is called after the layout instance has been created, it will force a reflow of the
layout and pick up changes to all of the layout*Margin properties.layoutMargin
- New layoutMargin value. Default value is nullLayout
instance, for chaining setter callssetLayoutLeftMargin(java.lang.Integer)
,
setLayoutRightMargin(java.lang.Integer)
,
setLayoutBottomMargin(java.lang.Integer)
,
setLayoutTopMargin(java.lang.Integer)
,
setPaddingAsLayoutMargin(java.lang.Boolean)
,
User Sizing Examplepublic java.lang.Integer getLayoutMargin()
layoutLeftMargin
and related properties do not have a
true setter method. If this method is called after the layout instance has been created, it will force a reflow of the
layout and pick up changes to all of the layout*Margin properties.getLayoutLeftMargin()
,
getLayoutRightMargin()
,
getLayoutBottomMargin()
,
getLayoutTopMargin()
,
getPaddingAsLayoutMargin()
,
User Sizing Examplepublic Layout setLayoutRightMargin(java.lang.Integer layoutRightMargin)
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
layoutRightMargin
- New layoutRightMargin value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Integer getLayoutRightMargin()
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
public Layout setLayoutStartMargin(java.lang.Integer layoutStartMargin)
layoutLeftMargin
for a horizontal
layout, or layoutTopMargin
for a vertical layout.
If both layoutStartMargin
and the more specific properties (top/left margin) are both set, the more
specific properties win.
layoutStartMargin
- New layoutStartMargin value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Integer getLayoutStartMargin()
layoutLeftMargin
for a horizontal
layout, or layoutTopMargin
for a vertical layout.
If both layoutStartMargin
and the more specific properties (top/left margin) are both set, the more
specific properties win.
public Layout setLayoutTopMargin(java.lang.Integer layoutTopMargin)
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
layoutTopMargin
- New layoutTopMargin value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Integer getLayoutTopMargin()
layoutMargin
. Requires a manual call to
setLayoutMargin()
if changed on the fly.
public Layout setLeaveScrollbarGap(java.lang.Boolean leaveScrollbarGap) throws java.lang.IllegalStateException
This setting avoids the layout resizing all members when the vertical scrollbar is introduced or removed, which can avoid unnecessary screen shifting and improve performance.
leaveScrollbarGap
- New leaveScrollbarGap value. Default value is falseLayout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getLeaveScrollbarGap()
This setting avoids the layout resizing all members when the vertical scrollbar is introduced or removed, which can avoid unnecessary screen shifting and improve performance.
public Layout setLocateMembersBy(LocatorStrategy locateMembersBy)
AutomatedTesting
system, strategy to use when generated locators for
members from within this Layout's members array.
Note : This is an advanced setting
locateMembersBy
- New locateMembersBy value. Default value is nullLayout
instance, for chaining setter callspublic LocatorStrategy getLocateMembersBy()
AutomatedTesting
system, strategy to use when generated locators for
members from within this Layout's members array.public Layout setLocateMembersType(LocatorTypeStrategy locateMembersType)
LocatorTypeStrategy
to use when finding members within this layout.
Note : This is an advanced setting
locateMembersType
- New locateMembersType value. Default value is nullLayout
instance, for chaining setter callspublic LocatorTypeStrategy getLocateMembersType()
LocatorTypeStrategy
to use when finding members within this layout.public Layout setManagePercentBreadth(java.lang.Boolean managePercentBreadth) throws java.lang.IllegalStateException
layoutMargin
. If false,
percentages work exactly as for a non-member, with layoutMargins, if any, ignored.managePercentBreadth
- New managePercentBreadth value. Default value is trueLayout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getManagePercentBreadth()
layoutMargin
. If false,
percentages work exactly as for a non-member, with layoutMargins, if any, ignored.public Layout setMemberOverlap(int memberOverlap) throws java.lang.IllegalStateException
memberOverlap
can be used in conjunction with stackZIndex
to create a particular visual stacking order.
Note that overlap of individual members can be accomplished with a negative setting for Canvas.extraSpace
.
memberOverlap
- New memberOverlap value. Default value is 0Layout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdLayoutMember overview and related methods
public int getMemberOverlap()
memberOverlap
can be used in conjunction with stackZIndex
to create a particular visual stacking order.
Note that overlap of individual members can be accomplished with a negative setting for Canvas.extraSpace
.
LayoutMember overview and related methods
public Layout setMembers(Canvas... members)
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 (see defaultLayoutAlign
for default implementation.)
showResizeBar
-- set to true to show a resize bar
(default is false) layout policy
. Note that it is valid to have null slots
in the provided members
Array, and the Layout will ignore those slots. This can be useful to keep code
compact, for example, when constructing the members
Array, you might use an expression that either returns
a component or null depending on whether the component should be present. If the expression returns null, the null slot
will be ignored by the Layout.
If this method is called after the component has been drawn/initialized:
Display a new set of members in this layout. Equivalent to calling removeMembers() then addMembers(). Note that the new members may include members already present, in which case they will be reordered / integrated with any other new members passed into this method.
members
- New members value. Default value is nullLayout
instance, for chaining setter callspublic Canvas[] getMembers()
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 (see defaultLayoutAlign
for default implementation.)
showResizeBar
-- set to true to show a resize bar
(default is false) layout policy
. Note that it is valid to have null slots
in the provided members
Array, and the Layout will ignore those slots. This can be useful to keep code
compact, for example, when constructing the members
Array, you might use an expression that either returns
a component or null depending on whether the component should be present. If the expression returns null, the null slot
will be ignored by the Layout.
public Layout setMembersMargin(int membersMargin)
Requires a manual call to reflow()
if changed on the fly.
membersMargin
- New membersMargin value. Default value is 0Layout
instance, for chaining setter callspublic int getMembersMargin()
Requires a manual call to reflow()
if changed on the fly.
public Layout setMinBreadthMember(java.lang.String minBreadthMember)
minBreadthMember
(even though the Layout might not actually be that
wide, and may overflow its assigned size along the breadth axis due to the breadth of the minBreadthMember
.
Without this property set, members of a layout aren't ever expanded in breadth (by the layout) to fit an overflow of the layout along the breadth axis. Setting this property will make sure all members (other than the one specified) get expanded to fill the full visual breadth of the layout (assuming they are configured to use 100% layout breadth).
Note : This is an advanced setting
minBreadthMember
- New minBreadthMember value. Default value is nullLayout
instance, for chaining setter callsLayoutPolicy
public Layout setMinBreadthMember(int minBreadthMember)
minBreadthMember
(even though the Layout might not actually be that
wide, and may overflow its assigned size along the breadth axis due to the breadth of the minBreadthMember
.
Without this property set, members of a layout aren't ever expanded in breadth (by the layout) to fit an overflow of the layout along the breadth axis. Setting this property will make sure all members (other than the one specified) get expanded to fill the full visual breadth of the layout (assuming they are configured to use 100% layout breadth).
Note : This is an advanced setting
minBreadthMember
- New minBreadthMember value. Default value is nullLayout
instance, for chaining setter callsLayoutPolicy
public Layout setMinBreadthMember(Canvas minBreadthMember)
minBreadthMember
(even though the Layout might not actually be that
wide, and may overflow its assigned size along the breadth axis due to the breadth of the minBreadthMember
.
Without this property set, members of a layout aren't ever expanded in breadth (by the layout) to fit an overflow of the layout along the breadth axis. Setting this property will make sure all members (other than the one specified) get expanded to fill the full visual breadth of the layout (assuming they are configured to use 100% layout breadth).
Note : This is an advanced setting
minBreadthMember
- New minBreadthMember value. Default value is nullLayout
instance, for chaining setter callsLayoutPolicy
public Layout setMinMemberLength(int minMemberLength)
Does not apply to members given a fixed size in pixels - such members will never be shrunk below their specified size in general.
minMemberLength
- New minMemberLength value. Default value is 1Layout
instance, for chaining setter callsCanvas.setMinWidth(int)
public int getMinMemberLength()
Does not apply to members given a fixed size in pixels - such members will never be shrunk below their specified size in general.
Canvas.getMinWidth()
public Layout setMinMemberSize(int minMemberSize)
minMemberLength
minMemberLength
.minMemberSize
- New minMemberSize value. Default value is 1Layout
instance, for chaining setter callspublic int getMinMemberSize()
minMemberLength
minMemberLength
.public Layout setOverflow(Overflow overflow)
LayoutPolicy
. Note that for overflow: "auto",
"scroll", or "visible", members exceeding the Layout's specified breadth but falling short of its overflow breadth will
keep the alignment set via defaultLayoutAlign
or
Canvas.layoutAlign
.
setOverflow
in class Canvas
overflow
- New overflow value. Default value is "visible"Layout
instance, for chaining setter callsCanvas.setOverflow(com.smartgwt.client.types.Overflow)
,
setMinBreadthMember(java.lang.String)
public Overflow getOverflow()
LayoutPolicy
. Note that for overflow: "auto",
"scroll", or "visible", members exceeding the Layout's specified breadth but falling short of its overflow breadth will
keep the alignment set via defaultLayoutAlign
or
Canvas.layoutAlign
.
getOverflow
in class Canvas
Canvas.getOverflow()
,
com.smartgwt.client.widgets.layout.Layout#getMinBreadthMember
public Layout setPaddingAsLayoutMargin(java.lang.Boolean paddingAsLayoutMargin)
this.padding
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.
Note : This is an advanced setting
paddingAsLayoutMargin
- New paddingAsLayoutMargin value. Default value is trueLayout
instance, for chaining setter callspublic java.lang.Boolean getPaddingAsLayoutMargin()
this.padding
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.
public Layout setPlaceHolderDefaults(Canvas placeHolderDefaults) throws java.lang.IllegalStateException
this.showDragPlaceHolder
is true, this
defaults object determines the default appearance of the placeholder displayed when the user drags a widget out of this
layout.styleName
to "layoutPlaceHolder"
placeHolderDefaults
- New placeHolderDefaults value. Default value is nullLayout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDragdrop overview and related methods
,
SGWTProperties
public Layout setPlaceHolderProperties(Canvas placeHolderProperties) throws java.lang.IllegalStateException
this.showDragPlaceHolder
is true, this
properties object can be used to customize the appearance of the placeholder displayed when the user drags a widget out
of this layout.placeHolderProperties
- New placeHolderProperties value. Default value is nullLayout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDragdrop overview and related methods
,
SGWTProperties
,
Drag move Examplepublic Splitbar getResizeBar()
Using AutoChildren
for details.
A MultiAutoChild created to resize members of this Layout
.
A resize bar will be created for any member of this Layout
that has
showResizeBar
set to true
. Resize bars will be
instances of the class specified by resizeBarClass
by default, and will
automatically be sized to the member's breadth, and to the thickness specified by
resizeBarSize
.
To customize the appearance or behavior of resizeBars within some layout a custom
resize bar class can be created by subclassing Splitbar
or ImgSplitbar
and
setting resizeBarClass
or
resizeBarConstructor
to this custom class.
Alternatively, Canvas.setAutoChildProperties(java.lang.String,
com.smartgwt.client.widgets.Canvas)
may be called to set resizeBar properties:
final Splitbar resizeBarProperties = new Splitbar(); //... layout.setAutoChildProperties("resizeBar", resizeBarProperties);See
AutoChildUsage
for more information.
If you create a custom resize bar class in Java, enable Reflection
to
allow it to be used.
Alternatively, you can use the SmartClient class system to create a simple
SmartClient subclass of either Splitbar
or ImgSplitbar
for use with this API - see the Skinning Guide
for details.
The built-in Splitbar
class supports drag resizing of its target member,
and clicking on the bar with a mouse to collapse/uncollapse the target member.
public Layout setResizeBarClass(java.lang.String resizeBarClass)
resizeBars
. This may be
overridden by resizeBarConstructor
. Classes that are valid by default are Splitbar
, ImgSplitbar
, and Snapbar
.
Note : This is an advanced setting
resizeBarClass
- New resizeBarClass value. Default value is "Splitbar"Layout
instance, for chaining setter callsSplitbar
,
ImgSplitbar
public java.lang.String getResizeBarClass()
resizeBars
. This may be
overridden by resizeBarConstructor
. Classes that are valid by default are Splitbar
, ImgSplitbar
, and Snapbar
.
Splitbar
,
ImgSplitbar
public Layout setResizeBarSize(int resizeBarSize)
Note : This is an advanced setting
resizeBarSize
- New resizeBarSize value. Default value is 7Layout
instance, for chaining setter callspublic int getResizeBarSize()
public Layout setReverseOrder(java.lang.Boolean reverseOrder)
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.
reverseOrder
- New reverseOrder value. Default value is falseLayout
instance, for chaining setter callspublic java.lang.Boolean getReverseOrder()
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.
public Layout setShowDragPlaceHolder(java.lang.Boolean showDragPlaceHolder)
showDragPlaceHolder
- New showDragPlaceHolder value. Default value is nullLayout
instance, for chaining setter callsDragdrop overview and related methods
,
Drag move Examplepublic java.lang.Boolean getShowDragPlaceHolder()
Dragdrop overview and related methods
,
Drag move Examplepublic Layout setShowDropLines(java.lang.Boolean showDropLines)
showDropLines
- New showDropLines value. Default value is nullLayout
instance, for chaining setter callsDragdrop overview and related methods
public java.lang.Boolean getShowDropLines()
Dragdrop overview and related methods
public Layout setStackZIndex(java.lang.String stackZIndex) throws java.lang.IllegalStateException
memberOverlap
, controls
the z-stacking order of members. If set to "lastOnTop", members stack from the first member at bottom to the last member at top. If set to "firstOnTop", members stack from the last member at bottom to the first member at top.
stackZIndex
- New stackZIndex value. Default value is nullLayout
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getStackZIndex()
memberOverlap
, controls
the z-stacking order of members. If set to "lastOnTop", members stack from the first member at bottom to the last member at top. If set to "firstOnTop", members stack from the last member at bottom to the first member at top.
public Layout setVertical(java.lang.Boolean vertical)
false
if
unspecified.vertical
- New vertical value. Default value is nullLayout
instance, for chaining setter callspublic java.lang.Boolean getVertical()
false
if
unspecified.public Layout setVPolicy(LayoutPolicy vPolicy)
Note : This is an advanced setting
vPolicy
- New vPolicy value. Default value is "fill"Layout
instance, for chaining setter callspublic LayoutPolicy getVPolicy()
public java.lang.Integer getChildTabPosition(Canvas child)
As with Canvas.getChildTabPosition()
if Canvas.setRelativeTabPosition()
was called explicitly called for some child, it will be respected over member order.
getChildTabPosition
in class Canvas
child
- The child for which the tab position should be returnedpublic int getDropPosition()
Use this method to obtain the drop position for e.g. a custom drop handler.
public Canvas getMember(java.lang.String memberID)
name
or member ID
, return a pointer to the appropriate member. If passed a member Canvas,
just returns it. Note that if more than one member has the same name
, passing in a name
has an undefined result.
memberID
- identifier for the required membergetMemberNumber(java.lang.String)
public void getMemberDefaultBreadth(Canvas member, int defaultBreadth)
managePercentBreadth
:true. Called only for
Layouts which have a layout policy
for the breadth axis of "fill", since
Layouts with a breadth policy of "none" leave all member breadths alone.
member
- Component to be sizeddefaultBreadth
- Value of the currently calculated member breadth. This may be returned verbatim or manipulated in this method.LayoutMember overview and related methods
public int getMemberNumber(java.lang.String memberID)
ID
or name
, return the index of that member within this layout's members array.
If passed a number, just returns it. Note that if more than one member has the same name
, passing in a
name
has an undefined result.
memberID
- identifier for the required membergetMember(java.lang.String)
public java.lang.Integer getMembersLength()
public java.lang.Boolean hasMember(Canvas canvas)
canvas
- the canvas to check forpublic void hideDropLine()
canDropComponents
set to true. This method is only
useful for custom implementations of drop()
as the default
implementation calls this method automatically.public void hideMember(Canvas member)
Members can always be directly
hidden via member.hide()
, but if animation
is enabled, animation will only occur if hideMember() is called to hide the member.
member
- Member to hidepublic void hideMember(Canvas member, Function callback)
Members can always be directly
hidden via member.hide()
, but if animation
is enabled, animation will only occur if hideMember() is called to hide the member.
member
- Member to hidecallback
- callback to fire when the member is hidden.public boolean layoutIsDirty()
Modifying the set of members, resizing members or changing layout settings will cause a recalculation of member sizes to be scheduled. The recalculation is delayed so that it is not performed redundantly if multiple changes are made in a row.
To force immediate
recalculation of new member sizes and resizing of members, call reflowNow()
.
public com.google.gwt.event.shared.HandlerRegistration addMembersChangedHandler(MembersChangedHandler handler)
Fires once at initialization if the layout has any initial members, and then fires whenever members are added, removed or reordered.
addMembersChangedHandler
in interface HasMembersChangedHandlers
handler
- the membersChanged handlerHandlerRegistration
used to remove this handlerpublic void reflow()
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
.
public void reflow(java.lang.String reason)
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
.
reason
- reason reflow() had to be called (appear in logs if enabled)public void reflowNow()
public void removeMember(Canvas member)
member
- the canvas to be removed from the layoutpublic void removeMembers(Canvas... members)
members
- array of members to be removed, or single memberpublic void removeMembers(Canvas members)
members
- array of members to be removed, or single memberpublic void reorderMember(int memberNum, int newPosition)
memberNum
- current position of the member to move to a new positionnewPosition
- new position to move the member topublic void reorderMembers(int start, int end, int newPosition)
start
- beginning of range of members to moveend
- end of range of members to move, non-inclusivenewPosition
- new position to move the members topublic void replaceMember(Canvas oldMember, Canvas newMember)
oldMember
- an existing member of the layout to be replacednewMember
- a different widget that should replace oldMember
RPCManager.createScreen(java.lang.String)
public void setVisibleMember(Canvas member)
member
- member to showpublic void showMember(Canvas member)
Members can always be directly
shown via member.show()
, but if animation
is enabled, animation will only occur if showMember() is called to show the member.
member
- Member to showpublic void showMember(Canvas member, Function callback)
Members can always be directly
shown via member.show()
, but if animation
is enabled, animation will only occur if showMember() is called to show the member.
member
- Member to showcallback
- action to fire when the member has been shownpublic static void setDefaultProperties(Layout layoutProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
layoutProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
protected void onInit_Layout()
public void addMembers(Canvas... newMembers)
newMembers
- canvases to be addedpublic void addMembers(Canvas[] newMembers, int position)
newMembers
- array of canvases to be addedposition
- position to add newMembers
positionpublic void addMember(com.google.gwt.user.client.ui.Widget widget)
widget
- the canvas object to be added to the layoutpublic void addMember(Canvas component)
component
- the canvas object to be added to the layoutpublic void addMember(com.google.gwt.user.client.ui.Widget widget, int position)
public void addMember(Canvas component, int position)
component
- the canvas object to be added to the layoutposition
- the position in the layout to place newMember (starts with 0);
if omitted, it will be added at the last positionprotected void addMemberPreCreate(java.lang.Object componentJS)
protected void addMemberPostCreate(java.lang.Object componentJS)
protected void addMemberPreCreate(java.lang.Object componentJS, int position)
protected void addMemberPostCreate(java.lang.Object componentJS, int position)
public void setDefaultLayoutAlign(Alignment alignment) throws java.lang.IllegalStateException
layoutAlign
.alignment
- defaultLayoutAlign Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic void setDefaultLayoutAlign(VerticalAlignment alignment) throws java.lang.IllegalStateException
layoutAlign
.alignment
- defaultLayoutAlign Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic void setDropLineProperties(Canvas dropLineProperties) throws java.lang.IllegalStateException
java.lang.IllegalStateException
public Layout setAlign(Alignment alignment)
defaultLayoutAlign
and
layoutAlign
.public void setAlign(VerticalAlignment alignment)
defaultLayoutAlign
and
layoutAlign
.alignment
- alignment Default value is nullpublic Canvas getMember(int index)
If passed a member Canvas, just returns it.
index
- index for the memberpublic int getMemberNumber(Canvas member)
If passed a number, just returns it.
member
- the memberpublic void revealChild(java.lang.String childID)
revealChild
in class Canvas
childID
- the global ID of the child Canvas to revealpublic void revealChild(Canvas child)
revealChild
in class Canvas
child
- the child Canvas to revealpublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.LayoutLogicalStructure s)
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure
interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure
in interface LogicalStructure
getLogicalStructure
in class Canvas