public class SectionStack extends VLayout implements HasSectionHeaderClickHandlers
SectionStack can be configured so that only one section is visible at a time (similar to MS Outlook's left-hand Nav), or to allow multiple sections to be visible and share the available space.
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
SectionStack() |
SectionStack(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
void |
addSection(SectionStackSection section)
Add a section to the SectionStack.
|
void |
addSection(SectionStackSection section,
int position)
Add a section to the SectionStack.
|
com.google.gwt.event.shared.HandlerRegistration |
addSectionHeaderClickHandler(SectionHeaderClickHandler handler)
Add a SectionHeaderClick 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 . |
void |
collapseSection(int sections)
Collapse a section or sections.
|
void |
collapseSection(int sections,
CollapseSectionCallback callback)
Collapse a section or sections.
|
void |
collapseSection(java.lang.String sectionID) |
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
expandSection(int sections)
Expands a section or sections.
|
void |
expandSection(int sections,
ExpandSectionCallback callback)
Expands a section or sections.
|
void |
expandSection(java.lang.String sectionID) |
java.lang.Boolean |
getAnimateSections()
If true, sections are animated during expand/collapse and addition/removal of SectionItems is likewise animated.
|
java.lang.Boolean |
getCanCollapseAll()
In
visibilityMode VisibilityMode.MUTEX , whether to allow the last remaining expanded section to be collapsed. |
java.lang.Boolean |
getCanDropComponents()
SectionStacks provide the same default implementation of drag and drop interactions as
Layouts , except that members are added as items into the
section over which they're dropped. |
java.lang.Boolean |
getCanReorderSections()
Whether sections can be drag reordered by the user dragging the section header.
|
java.lang.Boolean |
getCanResizeSections()
Whether sections can be drag resized by the user dragging the section header.
|
java.lang.Boolean |
getCanTabToHeaders()
If true, the headers for the sections (if shown) will be included in the page's tab order for accessibility.
|
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
int |
getHeaderHeight()
Height of headers for sections.
|
int |
getItemEndIndent()
Size, in pixels, of indentation of all member items relative to the end of the alignment axis.
|
int |
getItemIndent()
Size, in pixels, of indentation of all member items.
|
int |
getItemStartIndent()
Size, in pixels, of indentation of all member items relative to the start of the alignment axis.
|
LocatorStrategy |
getLocateSectionsBy()
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() , how should sections within this
stack be identified? By default if a section has a specified Section.name this will always be used. |
LocatorTypeStrategy |
getLocateSectionsType()
LocatorTypeStrategy to use when finding Sections within this section Stack. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
static SectionStack |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
Overflow |
getOverflow()
Normal
Overflow settings can be used on layouts, for example, an overflow:auto Layout
will scroll if sections are resized to exceed the specified size, whereas an overflow:visible Layout will grow to
accommodate the resized sections. |
java.lang.Boolean |
getScrollSectionIntoView()
If an expanded or shown section expands past the current viewport and this property is true, then the viewport will
auto-scroll to fit as much of the section content into the viewport without scrolling the top of the section out of the
viewport.
|
SectionStackSection |
getSection(int index)
Return the SectionStackSection for a section.
|
SectionStackSection |
getSection(java.lang.String sectionID)
Return the SectionStackSection for a section.
|
java.lang.String |
getSectionHeaderClass()
Widget to use for section headers.
|
int |
getSectionNumber(java.lang.String sectionName)
Returns the position of the specified section in the SectionStack.
|
SectionStackSection[] |
getSections() |
java.lang.Boolean |
getShowExpandControls()
Whether to show the Expand/Collapse controls in the headers of sections.
|
java.lang.String |
getStyleName()
Default CSS style for the SectionStack as a whole.
|
java.lang.Boolean |
getUseGlobalSectionIDs()
Should any specified
SectionStackSection.ID be
applied to the generated SectionHeader widget for the section as a widget ID? If set to false, SectionStackSection.ID
will behave as a synonym for SectionStackSection.name. |
VisibilityMode |
getVisibilityMode()
Whether multiple sections can be expanded.
|
void |
hideSection(int sections)
Hides a section or sections.
|
void |
hideSection(int sections,
HideSectionCallback callback)
Hides a section or sections.
|
void |
hideSection(java.lang.String sectionID) |
void |
moveSection(int sections,
int position)
Moves the specified section(s) to a new position in the SectionStack order.
|
void |
moveSection(java.lang.String sectionID,
int position) |
void |
removeSection(int sections)
Remove a section or set of sections from the SectionStack.
|
void |
removeSection(java.lang.String sectionID) |
void |
revealChild(Canvas child)
Reveals the child Canvas passed in by expanding the section containing that child if it is currently collapsed.
|
void |
revealChild(java.lang.String child)
Reveals the child Canvas passed in by expanding the section containing that child if it is currently collapsed.
|
SectionStackSection |
sectionForItem(Canvas item)
Search for a section that contains passed item.
|
void |
sectionHeaderClick(Canvas sectionHeader)
Method intended to be called by the sectionHeader when it is clicked on.
|
boolean |
sectionIsExpanded(int section)
Returns true if the specified section is expanded, false if it is collapsed.
|
boolean |
sectionIsExpanded(java.lang.String sectionID) |
boolean |
sectionIsVisible(int section)
Returns true if the specified section is visible, false if it is not.
|
boolean |
sectionIsVisible(java.lang.String sectionID) |
void |
setAnimateSections(java.lang.Boolean animateSections)
If true, sections are animated during expand/collapse and addition/removal of SectionItems is likewise animated.
|
void |
setCanCollapseAll(java.lang.Boolean canCollapseAll)
In
visibilityMode VisibilityMode.MUTEX , whether to allow the last remaining expanded section to be collapsed. |
void |
setCanDropComponents(java.lang.Boolean canDropComponents)
SectionStacks provide the same default implementation of drag and drop interactions as
Layouts , except that members are added as items into the
section over which they're dropped. |
void |
setCanReorderSections(java.lang.Boolean canReorderSections)
Whether sections can be drag reordered by the user dragging the section header.
|
void |
setCanResizeSections(java.lang.Boolean canResizeSections)
Whether sections can be drag resized by the user dragging the section header.
|
void |
setCanTabToHeaders(java.lang.Boolean canTabToHeaders)
If true, the headers for the sections (if shown) will be included in the page's tab order for accessibility.
|
static void |
setDefaultProperties(SectionStack sectionStackProperties)
Class level method to set the default properties of this class.
|
void |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
void |
setHeaderHeight(int headerHeight)
Height of headers for sections.
|
void |
setItemEndIndent(int itemEndIndent)
Size, in pixels, of indentation of all member items relative to the end of the alignment axis.
|
void |
setItemIndent(int itemIndent)
Size, in pixels, of indentation of all member items.
|
void |
setItemStartIndent(int itemStartIndent)
Size, in pixels, of indentation of all member items relative to the start of the alignment axis.
|
void |
setLocateSectionsBy(LocatorStrategy locateSectionsBy)
When
AutoTest.getElement() is used to parse locator strings
generated by AutoTest.getLocator() , how should sections within this
stack be identified? By default if a section has a specified Section.name this will always be used. |
void |
setLocateSectionsType(LocatorTypeStrategy locateSectionsType)
LocatorTypeStrategy to use when finding Sections within this section Stack. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.SectionStackLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
void |
setOverflow(Overflow overflow)
Normal
Overflow settings can be used on layouts, for example, an overflow:auto Layout
will scroll if sections are resized to exceed the specified size, whereas an overflow:visible Layout will grow to
accommodate the resized sections. |
void |
setScrollSectionIntoView(java.lang.Boolean scrollSectionIntoView)
If an expanded or shown section expands past the current viewport and this property is true, then the viewport will
auto-scroll to fit as much of the section content into the viewport without scrolling the top of the section out of the
viewport.
|
void |
setSectionHeaderClass(java.lang.Class<? extends Canvas> sectionHeaderClass) |
void |
setSectionHeaderClass(java.lang.String sectionHeaderClass)
Widget to use for section headers.
|
void |
setSectionProperties(int index,
SectionStackSection properties) |
void |
setSectionProperties(java.lang.String section,
SectionStackSection properties)
Set arbitrary properties for a particular section in this SectionStack.
|
void |
setSections(SectionStackSection... sections) |
void |
setSectionTitle(int index,
java.lang.String newTitle)
|
void |
setSectionTitle(java.lang.String section,
java.lang.String newTitle)
Changes the title of a SectionHeader.
|
void |
setShowExpandControls(java.lang.Boolean showExpandControls)
Whether to show the Expand/Collapse controls in the headers of sections.
|
void |
setStyleName(java.lang.String styleName)
Default CSS style for the SectionStack as a whole.
|
void |
setUseGlobalSectionIDs(java.lang.Boolean useGlobalSectionIDs)
Should any specified
SectionStackSection.ID be
applied to the generated SectionHeader widget for the section as a widget ID? If set to false, SectionStackSection.ID
will behave as a synonym for SectionStackSection.name. |
void |
setVisibilityMode(VisibilityMode visibilityMode)
Whether multiple sections can be expanded.
|
void |
showSection(int sections)
Shows a section or sections.
|
void |
showSection(int sections,
ShowSectionCallback callback)
Shows a section or sections.
|
void |
showSection(java.lang.String sectionID) |
setDefaultProperties, setLogicalStructure
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, addMembersChangedHandler, getAnimateMembers, getAnimateMemberTime, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOverlap, getMembers, getMembersLength, getMembersMargin, getMinMemberLength, getMinMemberSize, getPaddingAsLayoutMargin, getResizeBar, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, layoutIsDirty, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, removeMembers, removeMembers, reorderMember, reorderMembers, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutTopMargin, setLeaveScrollbarGap, setLocateMembersBy, setLocateMembersType, setLogicalStructure, setManagePercentBreadth, setMemberOverlap, setMembers, setMembersMargin, setMinBreadthMember, setMinBreadthMember, setMinBreadthMember, setMinMemberLength, setMinMemberSize, setPaddingAsLayoutMargin, setPlaceHolderDefaults, setPlaceHolderProperties, setResizeBarClass, setResizeBarSize, setReverseOrder, setShowDragPlaceHolder, setShowDropLines, setStackZIndex, setVertical, setVisibleMember, setVPolicy, showMember, showMember
addChild, addChild, addChild, addChild, addChild, 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, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, 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, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, 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, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
addDrawHandler, applyFactoryProperties, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getById, getByJSObject, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, 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 SectionStack()
public SectionStack(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SectionStack 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 void setAnimateSections(java.lang.Boolean animateSections)
animateSections
- Default value is nullpublic java.lang.Boolean getAnimateSections()
public void setCanCollapseAll(java.lang.Boolean canCollapseAll)
visibilityMode
VisibilityMode.MUTEX
, whether to allow the last remaining expanded section to be collapsed.
If false, collapsing the last open section will open the next one (wrapping around at the end).canCollapseAll
- Default value is truepublic java.lang.Boolean getCanCollapseAll()
visibilityMode
VisibilityMode.MUTEX
, whether to allow the last remaining expanded section to be collapsed.
If false, collapsing the last open section will open the next one (wrapping around at the end).public void setCanDropComponents(java.lang.Boolean canDropComponents) throws java.lang.IllegalStateException
Layouts
, except that members are added as items into the
section over which they're dropped. 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 SectionStack.
Note : This is an advanced setting
setCanDropComponents
in class Layout
canDropComponents
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDragdrop overview and related methods
public java.lang.Boolean getCanDropComponents()
Layouts
, except that members are added as items into the
section over which they're dropped. 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 SectionStack.
getCanDropComponents
in class Layout
Dragdrop overview and related methods
public void setCanReorderSections(java.lang.Boolean canReorderSections) throws java.lang.IllegalStateException
Note that, with
canReorderSections:true
, sections with section.canReorder:false
will not be able to be
drag-reordered (though their index may still be changed by dropping other sections above or below them in the section
stack).
Note : This is an advanced setting
canReorderSections
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanReorderSections()
Note that, with
canReorderSections:true
, sections with section.canReorder:false
will not be able to be
drag-reordered (though their index may still be changed by dropping other sections above or below them in the section
stack).
public void setCanResizeSections(java.lang.Boolean canResizeSections) throws java.lang.IllegalStateException
Note that, with
canResizeSections:true
, not all sections can be resized: sections that contain only autofitting
components or that are marked with section.resizeable:false
will not be resizeable.
Note : This is an advanced setting
canResizeSections
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanResizeSections()
Note that, with
canResizeSections:true
, not all sections can be resized: sections that contain only autofitting
components or that are marked with section.resizeable:false
will not be resizeable.
public void setCanTabToHeaders(java.lang.Boolean canTabToHeaders) throws java.lang.IllegalStateException
SectionStackSection.canTabToHeader
If unset, section headers will be focusable if isc.setScreenReaderMode()
has been called. See Accessibility
.
Note : This is an advanced setting
canTabToHeaders
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanTabToHeaders()
SectionStackSection.canTabToHeader
If unset, section headers will be focusable if isc.setScreenReaderMode()
has been called. See Accessibility
.
public void 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 Layout
editProxyConstructor
- java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCClassName . Default value is "SectionStackEditProxy"
public java.lang.String getEditProxyConstructor()
EditProxy
for this component when the component is
first placed into edit mode
.getEditProxyConstructor
in class Layout
SCClassName
public void setHeaderHeight(int headerHeight) throws java.lang.IllegalStateException
headerHeight
- Default value is 20java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getHeaderHeight()
public void setItemEndIndent(int itemEndIndent)
itemEndIndent
- Default value is undefinedLayoutMember overview and related methods
public int getItemEndIndent()
LayoutMember overview and related methods
public void setItemIndent(int itemIndent)
itemStartIndent
or itemEndIndent
. Setting itemIndent is equivalent to
setting itemStartIndent to the same amount and itemEndIndent to 0.itemIndent
- Default value is 0LayoutMember overview and related methods
public int getItemIndent()
itemStartIndent
or itemEndIndent
. Setting itemIndent is equivalent to
setting itemStartIndent to the same amount and itemEndIndent to 0.LayoutMember overview and related methods
public void setItemStartIndent(int itemStartIndent)
itemIndent
.itemStartIndent
- Default value is undefinedLayoutMember overview and related methods
public int getItemStartIndent()
itemIndent
.LayoutMember overview and related methods
public void setLocateSectionsBy(LocatorStrategy locateSectionsBy)
AutoTest.getElement()
is used to parse locator strings
generated by AutoTest.getLocator()
, how should sections within this
stack be identified? By default if a section has a specified Section.name
this will always be used. For sections
with no name, the following options are available: "title"
use the title as an identifier"index"
use the index of the section in the sections array as an identifierNote : This is an advanced setting
locateSectionsBy
- Default value is nullpublic LocatorStrategy getLocateSectionsBy()
AutoTest.getElement()
is used to parse locator strings
generated by AutoTest.getLocator()
, how should sections within this
stack be identified? By default if a section has a specified Section.name
this will always be used. For sections
with no name, the following options are available: "title"
use the title as an identifier"index"
use the index of the section in the sections array as an identifierpublic void setLocateSectionsType(LocatorTypeStrategy locateSectionsType)
LocatorTypeStrategy
to use when finding Sections within this section Stack.
Note : This is an advanced setting
locateSectionsType
- Default value is nullpublic LocatorTypeStrategy getLocateSectionsType()
LocatorTypeStrategy
to use when finding Sections within this section Stack.public void setOverflow(Overflow overflow)
Overflow
settings can be used on layouts, for example, an overflow:auto Layout
will scroll if sections are resized to exceed the specified size, whereas an overflow:visible Layout will grow to
accommodate the resized sections.setOverflow
in class Layout
overflow
- Default value is "hidden"Canvas.setOverflow(com.smartgwt.client.types.Overflow)
,
Layout.setMinBreadthMember(java.lang.String)
public Overflow getOverflow()
Overflow
settings can be used on layouts, for example, an overflow:auto Layout
will scroll if sections are resized to exceed the specified size, whereas an overflow:visible Layout will grow to
accommodate the resized sections.getOverflow
in class Layout
Canvas.getOverflow()
,
com.smartgwt.client.widgets.layout.Layout#getMinBreadthMember
public void setScrollSectionIntoView(java.lang.Boolean scrollSectionIntoView) throws java.lang.IllegalStateException
scrollSectionIntoView
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getScrollSectionIntoView()
public void setSectionHeaderClass(java.lang.String sectionHeaderClass) throws java.lang.IllegalStateException
Must be a subclass of either ImgSectionHeader
or SectionHeader
. The
default class used depends on the skin; SectionHeader
is the simpler and
lighter-weight class and uses CSS styling rather than image-based styling, and is recommended for most use cases.
If you create a custom section header 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 SectionHeader or ImgSectionHeader for use with this API - see the Skinning Guide
for details.
If you override event handlers on your custom SectionHeader or radically change it's
structure such that the default event handling no longer works, you can call sectionHeaderClick()
to replicate the built-in
expand/collapse handling for clicking a section header.
Note : This is an advanced setting
sectionHeaderClass
- Default value is "SectionHeader"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSectionHeaderClass()
Must be a subclass of either ImgSectionHeader
or SectionHeader
. The
default class used depends on the skin; SectionHeader
is the simpler and
lighter-weight class and uses CSS styling rather than image-based styling, and is recommended for most use cases.
If you create a custom section header 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 SectionHeader or ImgSectionHeader for use with this API - see the Skinning Guide
for details.
If you override event handlers on your custom SectionHeader or radically change it's
structure such that the default event handling no longer works, you can call sectionHeaderClick()
to replicate the built-in
expand/collapse handling for clicking a section header.
public void setShowExpandControls(java.lang.Boolean showExpandControls)
showExpandControls
- Default value is truepublic java.lang.Boolean getShowExpandControls()
public void setStyleName(java.lang.String styleName) throws java.lang.IllegalStateException
setStyleName
in class Canvas
styleName
- java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName . Default value is "sectionStack"
public java.lang.String getStyleName()
getStyleName
in class Canvas
CSSStyleName
public void setUseGlobalSectionIDs(java.lang.Boolean useGlobalSectionIDs) throws java.lang.IllegalStateException
SectionStackSection.ID
be
applied to the generated SectionHeader widget for the section as a widget ID? If set to false, SectionStackSection.ID
will behave as a synonym for SectionStackSection.name.useGlobalSectionIDs
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseGlobalSectionIDs()
SectionStackSection.ID
be
applied to the generated SectionHeader widget for the section as a widget ID? If set to false, SectionStackSection.ID
will behave as a synonym for SectionStackSection.name.public void setVisibilityMode(VisibilityMode visibilityMode)
visibilityMode
.visibilityMode
- new visibilityMode
setting. If this is VisibilityMode.MUTEX
then all but
the first expanded section is collapsed.. Default value is "mutex"setCanCollapseAll(java.lang.Boolean)
,
Expand / Collapse Examplepublic VisibilityMode getVisibilityMode()
getCanCollapseAll()
,
Expand / Collapse Examplepublic void collapseSection(int sections)
sections
- Section(s) to collapse. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section positions / nameshideSection(int)
,
Expand / Collapse Examplepublic void collapseSection(int sections, CollapseSectionCallback callback)
sections
- Section(s) to collapse. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section positions / namescallback
- callback to fire when the section has been collapsedhideSection(int)
,
Expand / Collapse Examplepublic void expandSection(int sections)
sections
- Section(s) to expand. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section names/positions.showSection(int)
,
getScrollSectionIntoView()
,
Expand / Collapse Examplepublic void expandSection(int sections, ExpandSectionCallback callback)
sections
- Section(s) to expand. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section names/positions.callback
- callback to fire when the section has been expanded.showSection(int)
,
getScrollSectionIntoView()
,
Expand / Collapse Examplepublic int getSectionNumber(java.lang.String sectionName)
sectionName
- name of a section for which you want to obtain the position.public void hideSection(int sections)
sections
- Section(s) to hide. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section names / positions.collapseSection(int)
,
Show and Hide Examplepublic void hideSection(int sections, HideSectionCallback callback)
sections
- Section(s) to hide. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section names / positions.callback
- to fire when the section has been hiddencollapseSection(int)
,
Show and Hide Examplepublic void moveSection(int sections, int position)
newPosition
in the order specified by the sections
argument.sections
- Section(s) to move. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section names/positions.position
- new position index for the section(s).public com.google.gwt.event.shared.HandlerRegistration addSectionHeaderClickHandler(SectionHeaderClickHandler handler)
Notification method fired when the user clicks on a section header. Returning false will cancel the default behavior (expanding / collapsing the section)
addSectionHeaderClickHandler
in interface HasSectionHeaderClickHandlers
handler
- the SectionHeaderClick handlerHandlerRegistration
used to remove this handlerpublic void removeSection(int sections)
sections
- Section(s) to remove. For this parameter, you can pass the position of the section in the
SectionStack, the name
of the section, or a List of section name
s or
indices.public void revealChild(java.lang.String child)
revealChild
in class Canvas
child
- the child Canvas to reveal, or its global IDpublic void revealChild(Canvas child)
revealChild
in class Canvas
child
- the child Canvas to reveal, or its global IDpublic SectionStackSection sectionForItem(Canvas item)
item
- item to showexpandSection(int)
public void sectionHeaderClick(Canvas sectionHeader)
sectionHeader
- the sectionHeader clicked onpublic boolean sectionIsExpanded(int section)
section
- Section for which you want to obtain information. For this parameter, you can pass the position of
the section in the SectionStack, or the name of the section.public boolean sectionIsVisible(int section)
section
- Section for which you want to obtain visibility information. For this parameter, you can pass the
position of the section in the SectionStack, or the name of the section.public void setSectionProperties(java.lang.String section, SectionStackSection properties)
Note that where APIs exist to explicitly manipulate section properties these should be used in
preference to this method. For example, to add or remove items in a section use addItem()
or removeItem()
. To change the title of a section, use setSectionTitle()
.
Also note that to modify properties of items within a section, call the appropriate setter methods directly on the item you want to modify.
section
- ID or index of the section to modifyproperties
- properties to apply to the section.public void setSectionTitle(java.lang.String section, java.lang.String newTitle)
section
- ID or index of the section whose title you want to changenewTitle
- new title for the SectionHeaderpublic void showSection(int sections)
sections
- Section(s) to show. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section names / positions.expandSection(int)
,
getScrollSectionIntoView()
,
Show and Hide Examplepublic void showSection(int sections, ShowSectionCallback callback)
sections
- Section(s) to show. For this parameter, you can pass the position of the section in the
SectionStack, the name of the section, or a List of section names / positions.callback
- callback to fire when the sections have been shown.expandSection(int)
,
getScrollSectionIntoView()
,
Show and Hide Examplepublic static void setDefaultProperties(SectionStack sectionStackProperties)
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.
sectionStackProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public void setSectionHeaderClass(java.lang.Class<? extends Canvas> sectionHeaderClass) throws java.lang.IllegalStateException
java.lang.IllegalStateException
public void setSections(SectionStackSection... sections)
public void addSection(SectionStackSection section)
section
- the section to addpublic void addSection(SectionStackSection section, int position)
section
- the section to addposition
- index for the new sectionpublic void removeSection(java.lang.String sectionID)
sectionID
- the section IDremoveSection(int)
public void expandSection(java.lang.String sectionID)
sectionID
- the section IDexpandSection(int)
public void collapseSection(java.lang.String sectionID)
sectionID
- the section IDcollapseSection(int)
public void hideSection(java.lang.String sectionID)
sectionID
- the section IDhideSection(int)
public void showSection(java.lang.String sectionID)
sectionID
- the section IDshowSection(int)
public void moveSection(java.lang.String sectionID, int position)
sectionID
- the section IDposition
- new position index for the sectionmoveSection(int, int)
public boolean sectionIsExpanded(java.lang.String sectionID)
sectionID
- the section IDsectionIsExpanded(int)
public boolean sectionIsVisible(java.lang.String sectionID)
sectionID
- the section IDsectionIsVisible(int)
public void setSectionTitle(int index, java.lang.String newTitle)
index
- index of the section whose title you want to changenewTitle
- new title for the Section HeadersetSectionTitle(String, String)
public SectionStackSection getSection(java.lang.String sectionID)
sectionID
- ID of the section for which you want the headerpublic SectionStackSection getSection(int index)
index
- index of the section for which you want the headerpublic SectionStackSection[] getSections()
public void setSectionProperties(int index, SectionStackSection properties)
section
- ID or index of the section to modifyproperties
- properties to apply to the section.setSectionProperties(String,SectionStackSection)
public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.SectionStackLogicalStructure 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 VLayout