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. For further details, see visibilityMode
.
To ensure all sections are
accessible, you may need to set overflow
to enable
scrolling.
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 |
addItem(java.lang.String section,
Canvas item,
int index)
Add a canvas as an item to a section.
|
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 |
closeSection(SectionStackSection section)
Close a section.
|
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.
|
boolean |
getCanCloseSections()
Should sections be closeable if
SectionStackSection.canClose is not explicitly specified? |
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.
|
ImgButton |
getCloseSectionButton()
Note : This API is non-functional (always returns null) and exists only to make
you aware that this MultiAutoChild exists.
|
java.lang.String |
getCloseSectionButtonConstructor()
Constructor class for
closeSectionButton
autochildren. |
ImgButton |
getCloseSectionButtonDefaults()
Default properties for the
closeSectionButton . |
java.lang.String |
getCloseSectionIcon()
Default icon src for the
close button for
canClose:true sections. |
int |
getCloseSectionIconSize()
Pixel width/height for the
closeSectionIcon . |
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.
|
java.util.List |
getSectionNames()
Returns a list of all
section names in the order
in which they appear in the SectionStack. |
int |
getSectionNumber(java.lang.String sectionName)
Returns the position of the specified section in the SectionStack.
|
SectionStackSection[] |
getSections()
Return all the SectionStackSections in this SectionStack.
|
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 |
removeItem(java.lang.String section,
Canvas item)
Remove an item from a section.
|
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 childID)
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) |
SectionStack |
setAnimateSections(java.lang.Boolean animateSections)
If true, sections are animated during expand/collapse and addition/removal of SectionItems is likewise animated.
|
SectionStack |
setCanCloseSections(boolean canCloseSections)
Should sections be closeable if
SectionStackSection.canClose is not explicitly specified? |
SectionStack |
setCanCollapseAll(java.lang.Boolean canCollapseAll)
In
visibilityMode VisibilityMode.MUTEX , whether to allow the last remaining expanded section to be collapsed. |
SectionStack |
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. |
SectionStack |
setCanReorderSections(java.lang.Boolean canReorderSections)
Whether sections can be drag reordered by the user dragging the section header.
|
SectionStack |
setCanResizeSections(java.lang.Boolean canResizeSections)
Whether sections can be drag resized by the user dragging the section header.
|
SectionStack |
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.
|
SectionStack |
setCloseSectionButtonConstructor(java.lang.String closeSectionButtonConstructor)
Constructor class for
closeSectionButton
autochildren. |
SectionStack |
setCloseSectionButtonDefaults(ImgButton closeSectionButtonDefaults)
Default properties for the
closeSectionButton . |
SectionStack |
setCloseSectionIcon(java.lang.String closeSectionIcon)
Default icon src for the
close button for
canClose:true sections. |
SectionStack |
setCloseSectionIconSize(int closeSectionIconSize)
Pixel width/height for the
closeSectionIcon . |
static void |
setDefaultProperties(SectionStack sectionStackProperties)
Class level method to set the default properties of this class.
|
SectionStack |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
SectionStack |
setHeaderHeight(int headerHeight)
Height of headers for sections.
|
SectionStack |
setItemEndIndent(int itemEndIndent)
Size, in pixels, of indentation of all member items relative to the end of the alignment axis.
|
SectionStack |
setItemIndent(int itemIndent)
Size, in pixels, of indentation of all member items.
|
void |
setItems(java.lang.String section,
Canvas... items)
Sets a new list of canvii as items into the specified section by removing the existing items, then adding the new ones.
|
SectionStack |
setItemStartIndent(int itemStartIndent)
Size, in pixels, of indentation of all member items relative to the start of the alignment axis.
|
SectionStack |
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. |
SectionStack |
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. |
SectionStack |
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. |
SectionStack |
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) |
SectionStack |
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.
|
SectionStack |
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.
|
SectionStack |
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. |
SectionStack |
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, getChildTabPosition, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutEndMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutStartMargin, 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, replaceMember, setAlign, setAlign, setAnimateMembers, setAnimateMemberTime, setDefaultLayoutAlign, setDefaultLayoutAlign, setDefaultProperties, setDefaultResizeBars, setDropLineProperties, setDropLineThickness, setEnforcePolicy, setHPolicy, setLayoutBottomMargin, setLayoutEndMargin, setLayoutLeftMargin, setLayoutMargin, setLayoutRightMargin, setLayoutStartMargin, 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, 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, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, 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, getPendingMarkerStyle, getPendingMarkerVisible, 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, 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, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, 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, setDefiningProperty, setDefiningPropertyNameOptions, 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, setPendingMarkerStyle, setPendingMarkerVisible, 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, setTabIndex, setTestDataContext, setTitle, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, 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 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 SectionStack setAnimateSections(java.lang.Boolean animateSections)
animateSections
animateSections
- Should expand/collapse of section be animated?. Default value is nullSectionStack
instance, for chaining setter callspublic java.lang.Boolean getAnimateSections()
public SectionStack setCanCloseSections(boolean canCloseSections) throws java.lang.IllegalStateException
SectionStackSection.canClose
is not explicitly specified? Closeable sections show a close icon button
which will invoke closeSection()
when clicked.
canCloseSections
- New canCloseSections value. Default value is falseSectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic boolean getCanCloseSections()
SectionStackSection.canClose
is not explicitly specified? Closeable sections show a close icon button
which will invoke closeSection()
when clicked.
public SectionStack 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
- New canCollapseAll value. Default value is trueSectionStack
instance, for chaining setter callspublic 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 SectionStack 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
- New canDropComponents value. Default value is trueSectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdDrag and Drop
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
Drag and Drop
public SectionStack 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
- New canReorderSections value. Default value is falseSectionStack
instance, for chaining setter callsjava.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 SectionStack 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
- New canResizeSections value. Default value is trueSectionStack
instance, for chaining setter callsjava.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 SectionStack setCanTabToHeaders(java.lang.Boolean canTabToHeaders) throws java.lang.IllegalStateException
SectionStackSection.canTabToHeader
If unset, section headers will be focusable if SC.setScreenReaderMode()
has been called. See Accessibility
.
Note : This is an advanced setting
canTabToHeaders
- New canTabToHeaders value. Default value is nullSectionStack
instance, for chaining setter callsjava.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 SC.setScreenReaderMode()
has been called. See Accessibility
.
public ImgButton getCloseSectionButton()
Using AutoChildren
for details.
Automatically generated close icon button to show for canClose:true
sections.
This component will be
automatically added to the controls
for
canClose:true
sections.
Icon source is
derived from closeSectionIcon
or SectionStackSection.closeIcon
and related
properties.
public SectionStack setCloseSectionButtonConstructor(java.lang.String closeSectionButtonConstructor) throws java.lang.IllegalStateException
closeSectionButton
autochildren.closeSectionButtonConstructor
- New closeSectionButtonConstructor value. Default value is "ImgButton"SectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getCloseSectionButtonConstructor()
closeSectionButton
autochildren.public SectionStack setCloseSectionButtonDefaults(ImgButton closeSectionButtonDefaults) throws java.lang.IllegalStateException
closeSectionButton
. The default configuration includes a click handler to invoke closeSection()
closeSectionButtonDefaults
- New closeSectionButtonDefaults value. Default value is {...}SectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSGWTProperties
public ImgButton getCloseSectionButtonDefaults()
closeSectionButton
. The default configuration includes a click handler to invoke closeSection()
public SectionStack setCloseSectionIcon(java.lang.String closeSectionIcon) throws java.lang.IllegalStateException
close button
for
canClose:true
sections. May be overridden
by SectionStackSection.closeIcon
.
closeSectionIcon
- New closeSectionIcon value. Default value is "[SKIN]/actions/close.png"SectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdSCImgURL
public java.lang.String getCloseSectionIcon()
close button
for
canClose:true
sections. May be overridden
by SectionStackSection.closeIcon
.
SCImgURL
public SectionStack setCloseSectionIconSize(int closeSectionIconSize) throws java.lang.IllegalStateException
closeSectionIcon
.closeSectionIconSize
- New closeSectionIconSize value. Default value is 16SectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getCloseSectionIconSize()
closeSectionIcon
.public SectionStack 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
- New editProxyConstructor value. Default value is "SectionStackEditProxy"SectionStack
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 Layout
SCClassName
public SectionStack setHeaderHeight(int headerHeight) throws java.lang.IllegalStateException
headerHeight
- New headerHeight value. Default value is 20SectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getHeaderHeight()
public SectionStack setItemEndIndent(int itemEndIndent)
itemEndIndent
- New itemEndIndent value. Default value is undefinedSectionStack
instance, for chaining setter callsLayoutMember overview and related methods
public int getItemEndIndent()
LayoutMember overview and related methods
public SectionStack setItemIndent(int itemIndent)
itemStartIndent
or itemEndIndent
. Setting itemIndent is equivalent to
setting itemStartIndent to the same amount and itemEndIndent to 0.itemIndent
- New itemIndent value. Default value is 0SectionStack
instance, for chaining setter callsLayoutMember 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 SectionStack setItemStartIndent(int itemStartIndent)
itemIndent
.itemStartIndent
- New itemStartIndent value. Default value is undefinedSectionStack
instance, for chaining setter callsLayoutMember overview and related methods
public int getItemStartIndent()
itemIndent
.LayoutMember overview and related methods
public SectionStack 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
- New locateSectionsBy value. Default value is nullSectionStack
instance, for chaining setter callspublic 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 SectionStack setLocateSectionsType(LocatorTypeStrategy locateSectionsType)
LocatorTypeStrategy
to use when finding Sections within this section Stack.
Note : This is an advanced setting
locateSectionsType
- New locateSectionsType value. Default value is nullSectionStack
instance, for chaining setter callspublic LocatorTypeStrategy getLocateSectionsType()
LocatorTypeStrategy
to use when finding Sections within this section Stack.public SectionStack 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
- New overflow value. Default value is "hidden"SectionStack
instance, for chaining setter callsCanvas.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 SectionStack setScrollSectionIntoView(java.lang.Boolean scrollSectionIntoView) throws java.lang.IllegalStateException
scrollSectionIntoView
- New scrollSectionIntoView value. Default value is trueSectionStack
instance, for chaining setter callsjava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getScrollSectionIntoView()
public SectionStack 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
- New sectionHeaderClass value. Default value is "SectionHeader"SectionStack
instance, for chaining setter callsjava.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 SectionStack setShowExpandControls(java.lang.Boolean showExpandControls)
showExpandControls
- New showExpandControls value. Default value is trueSectionStack
instance, for chaining setter callspublic java.lang.Boolean getShowExpandControls()
public void setStyleName(java.lang.String styleName) throws java.lang.IllegalStateException
setStyleName
in class Canvas
styleName
- New styleName value. Default value is "sectionStack"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdCSSStyleName
public java.lang.String getStyleName()
getStyleName
in class Canvas
CSSStyleName
public SectionStack 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
- New useGlobalSectionIDs value. Default value is falseSectionStack
instance, for chaining setter callsjava.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 SectionStack 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"SectionStack
instance, for chaining setter callssetCanCollapseAll(java.lang.Boolean)
,
Expand / Collapse Examplepublic VisibilityMode getVisibilityMode()
getCanCollapseAll()
,
Expand / Collapse Examplepublic void addItem(java.lang.String section, Canvas item, int index)
section
- ID or index of the section to add item toitem
- Item to insert into the sectionindex
- Index into section to insert itempublic void closeSection(SectionStackSection section)
close button click
and will remove
the section by default.section
- section to closepublic 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 java.util.List getSectionNames()
section names
in the order
in which they appear in the SectionStack.public 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 removeItem(java.lang.String section, Canvas item)
section
- ID or index of the section to remove item fromitem
- Item to removepublic void removeSection(int sections)
items
will
also be destroyed if destroyOnRemove
is set on the section.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 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 setItems(java.lang.String section, Canvas... items)
SectionStackSection.items
.section
- ID or index of the section to set items onitems
- new items to addpublic 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 void revealChild(java.lang.String childID)
NOTE: This is an override point.
revealChild
in class Layout
childID
- the global ID of the child Canvas to revealpublic void revealChild(Canvas child)
NOTE: This is an override point.
revealChild
in class Layout
child
- the child Canvas to revealpublic 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