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, id, isElementSet, 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 index)
Collapse a section.
|
void |
collapseSection(java.lang.String sectionID)
Collapse a section.
|
protected com.google.gwt.core.client.JavaScriptObject |
create() |
void |
expandSection(int index)
Expands a section.
|
void |
expandSection(java.lang.String sectionID)
Expands a section.
|
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 "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.
|
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 link{isc.AutoTest.getLocator()}, how should
sections within this stack be identified? By default if section has a specified name this will always be used.
|
LocatorTypeStrategy |
getLocateSectionsType()
LocatorTypeStrategy to use when finding Sections within this section Stack. |
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure() |
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()
Name of a Smart GWT class to use for creating 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
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 visible at once
|
void |
hideSection(int index)
Hides a section.
|
void |
hideSection(java.lang.String sectionID)
Hides a section.
|
void |
moveSection(int index,
int position)
Moves the specified section to a new position in the SectionStack order.
|
void |
moveSection(java.lang.String sectionID,
int position)
Moves the specified section to a new position in the SectionStack order.
|
void |
removeSection(int index)
Remove a section from the SectionStack.
|
void |
removeSection(java.lang.String sectionID)
Remove a section from the SectionStack.
|
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 index)
Returns true if the specified section is expanded, false if it is collapsed.
|
boolean |
sectionIsExpanded(java.lang.String sectionID)
Returns true if the specified section is expanded, false if it is collapsed.
|
boolean |
sectionIsVisible(int index)
Returns true if the specified section is visible, false if it is not.
|
boolean |
sectionIsVisible(java.lang.String sectionID)
Returns true if the specified section is visible, false if it is not.
|
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 "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 |
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 |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
void |
setLocateSectionsBy(LocatorStrategy locateSectionsBy)
When AutoTest.getElement is used to parse locator strings generated by link{isc.AutoTest.getLocator()}, how should
sections within this stack be identified? By default if section has a specified 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) |
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.String sectionHeaderClass)
Name of a Smart GWT class to use for creating section headers.
|
void |
setSectionProperties(int section,
SectionStackSection properties)
Set arbitrary properties for a particular section in this SectionStack.
|
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)
Changes the title of a Section Header.
|
void |
setSectionTitle(java.lang.String sectionID,
java.lang.String newTitle)
Changes the title of a Section Header.
|
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
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 visible at once
|
void |
showSection(int index)
Shows a section.
|
void |
showSection(java.lang.String sectionID)
Shows a section.
|
setDefaultProperties, setLogicalStructure
addMember, addMember, addMember, addMember, addMemberPostCreate, addMemberPostCreate, addMemberPreCreate, addMemberPreCreate, addMembers, addMembers, getAnimateMembers, getAnimateMemberTime, getDefaultResizeBars, getDropComponent, getDropLine, getDropLineThickness, getDropPosition, getEnforcePolicy, getHPolicy, getLayoutBottomMargin, getLayoutLeftMargin, getLayoutMargin, getLayoutRightMargin, getLayoutTopMargin, getLeaveScrollbarGap, getLocateMembersBy, getLocateMembersType, getManagePercentBreadth, getMember, getMember, getMemberDefaultBreadth, getMemberNumber, getMemberNumber, getMemberOffset, getMemberOverlap, getMembers, getMembersMargin, getMinMemberSize, getPaddingAsLayoutMargin, getResizeBarClass, getResizeBarSize, getReverseOrder, getShowDragPlaceHolder, getShowDropLines, getStackZIndex, getVertical, getVPolicy, hasMember, hideDropLine, hideMember, hideMember, membersChanged, onInit_Layout, onInit, reflow, reflow, reflowNow, removeMember, 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, 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, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, 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, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, 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, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTestInstance, getTitle, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTitle, setTooltip, setTop, setTop, setUseBackMask, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, 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
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
public SectionStack()
public SectionStack(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SectionStack getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject
in class VLayout
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.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.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
public void setAnimateSections(java.lang.Boolean animateSections)
animateSections
- animateSections Default value is nullpublic java.lang.Boolean getAnimateSections()
public void setCanCollapseAll(java.lang.Boolean canCollapseAll)
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
- canCollapseAll Default value is truepublic java.lang.Boolean getCanCollapseAll()
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 canAcceptDrop
to true
and
canDropComponents
to false
on your SectionStack.
Note : This is an advanced setting
setCanDropComponents
in class Layout
canDropComponents
- 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 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
- 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
- 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
canTabToHeader
If unset, section headers will be focusable if setScreenReaderMode has been called. See Accessibility
.
Note : This is an advanced setting
canTabToHeaders
- canTabToHeaders Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getCanTabToHeaders()
canTabToHeader
If unset, section headers will be focusable if setScreenReaderMode has been called. See Accessibility
.
public void setHeaderHeight(int headerHeight) throws java.lang.IllegalStateException
headerHeight
- 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
- 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
- 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
- itemStartIndent Default value is undefinedLayoutMember overview and related methods
public int getItemStartIndent()
itemIndent
.LayoutMember overview and related methods
public void setLocateSectionsBy(LocatorStrategy locateSectionsBy)
"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
- locateSectionsBy Default value is nullpublic LocatorStrategy getLocateSectionsBy()
"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
- locateSectionsType Default value is nullpublic LocatorTypeStrategy getLocateSectionsType()
LocatorTypeStrategy
to use when finding Sections within this section Stack.public void setOverflow(Overflow overflow) throws java.lang.IllegalStateException
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
- overflow Default value is "hidden"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdSizing overview and related methods
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
Sizing overview and related methods
public void setScrollSectionIntoView(java.lang.Boolean scrollSectionIntoView) throws java.lang.IllegalStateException
scrollSectionIntoView
- 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
"SectionHeader"
or "ImgSectionHeader"
depending on the skin. You can use the
SmartClient class system to create a simple Smart GWT subclass of either SectionHeader or ImgSectionHeader for use
with this API - see the Skinning Guide
for details.
Note : This is an advanced setting
sectionHeaderClass
- . See Classname
. Default value is "SectionHeader"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getSectionHeaderClass()
"SectionHeader"
or "ImgSectionHeader"
depending on the skin. You can use the
SmartClient class system to create a simple Smart GWT subclass of either SectionHeader or ImgSectionHeader for use
with this API - see the Skinning Guide
for details.Classname
public void setShowExpandControls(java.lang.Boolean showExpandControls)
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
- . See CSSStyleName
. Default value is "sectionStack"java.lang.IllegalStateException
- this property cannot be changed after the component has been createdAppearance overview and related methods
,
CSS styles Examplepublic java.lang.String getStyleName()
getStyleName
in class Canvas
CSSStyleName
Appearance overview and related methods
,
CSS styles Examplepublic void setUseGlobalSectionIDs(java.lang.Boolean useGlobalSectionIDs) throws java.lang.IllegalStateException
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
- useGlobalSectionIDs Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getUseGlobalSectionIDs()
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 Default value is "mutex"VisibilityMode
,
Expand / Collapse Examplepublic VisibilityMode getVisibilityMode()
VisibilityMode
,
Expand / Collapse Examplepublic int getSectionNumber(java.lang.String sectionName)
sectionName
- name of a section for which you want to obtain the position.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 SectionStackSection sectionForItem(Canvas item)
item
- item to showpublic void sectionHeaderClick(Canvas sectionHeader)
sectionHeader
- the sectionHeader clicked onpublic static void setDefaultProperties(SectionStack sectionStackProperties)
Note: This method is intended for setting default attributes only and will effect 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.
sectionStackProperties
- properties that should be used as new defaults when instances of this class are createdpublic 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(int index)
index
- the section indexpublic void removeSection(java.lang.String sectionID)
sectionID
- the section IDpublic void expandSection(int index)
index
- the section indexpublic void expandSection(java.lang.String sectionID)
sectionID
- the section IDpublic void collapseSection(int index)
index
- the section indexpublic void collapseSection(java.lang.String sectionID)
sectionID
- the section IDpublic void hideSection(int index)
index
- the section indexpublic void hideSection(java.lang.String sectionID)
sectionID
- the section IDpublic void showSection(int index)
index
- the section indexpublic void showSection(java.lang.String sectionID)
sectionID
- the section IDpublic void moveSection(int index, int position)
index
- the section indexposition
- new position index for the sectionpublic void moveSection(java.lang.String sectionID, int position)
sectionID
- the section IDposition
- new position index for the sectionpublic boolean sectionIsExpanded(int index)
index
- position of the section in the SectionStackpublic boolean sectionIsExpanded(java.lang.String sectionID)
sectionID
- the section IDpublic boolean sectionIsVisible(int index)
index
- position of the section in the SectionStackpublic boolean sectionIsVisible(java.lang.String sectionID)
sectionID
- the section IDpublic void setSectionTitle(java.lang.String sectionID, java.lang.String newTitle)
sectionID
- ID of the section whose title you want to changenewTitle
- new title for the Section Headerpublic void setSectionTitle(int index, java.lang.String newTitle)
index
- index of the section whose title you want to changenewTitle
- new title for the Section Headerpublic 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(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 com.smartgwt.client.widgets.layout.SectionStack#addItem
or com.smartgwt.client.widgets.layout.SectionStack#removeItem
. To change the title of a section, use setSectionTitle(java.lang.String, java.lang.String)
.
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 setSectionProperties(int 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 com.smartgwt.client.widgets.layout.SectionStack#addItem
or com.smartgwt.client.widgets.layout.SectionStack#removeItem
. To change the title of a section, use setSectionTitle(java.lang.String, java.lang.String)
.
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 com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.layout.SectionStackLogicalStructure s)
public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
getLogicalStructure
in interface LogicalStructure
getLogicalStructure
in class VLayout