public class SectionStackSection extends RefDataClass
 A SectionStackSection can't be modified once it's been added to a SectionStack, which creates its section header (by default a SectionHeader, but see SectionStack.sectionHeaderClass).  After that,
 you must call the appropriate SectionStack method to modify a section property, or the section header
 getter method to get the updated property value.  As a convenience, we route several SectionStackSection
 setter methods to the SectionStack for you after the
 SectionStackSection has been added to it, but with the exception of items, you'll always get the original property values
 when calling a getter directly on a SectionStackSection. 
 Additional SectionHeader properties set on the
 SectionStackSection not explicitly documented, such as "iconAlign" or "prompt", are supported - use
 setAttribute().
| Modifier and Type | Field and Description | 
|---|---|
| protected SectionStack | stackOnce a SectionStackSection has been applied to a SectionStack, this method may be used to return  a pointer to the
 SectionStack in which this section header is embedded. | 
idfactoryCreated, factoryProperties| Constructor and Description | 
|---|
| SectionStackSection() | 
| SectionStackSection(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| SectionStackSection(java.lang.String title) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | addItem(Canvas item)Adds a new Canvas to this section, at the end. | 
| java.lang.Boolean | getCanClose()Is this section closeable? | 
| java.lang.Boolean | getCanTabToHeader()If true, the header for this Section will be included in the page's tab order for accessibility. | 
| java.lang.Boolean | getClipTitle()If the title for this section header is too large for the available space, should the title be clipped? | 
| java.lang.String | getCloseIcon()Icon src for the  close buttonifcanCloseis true. | 
| java.lang.Integer | getCloseIconSize()Pixel width/height for this sections  closeIcon.If unset SectionStack.closeSectionIconSizewill be used. | 
| Canvas[] | getControls()Custom controls to be shown on top of this section header. | 
| SectionHeader | getHeaderProperties()Allows properties for the header (a  SectionHeaderorImgSectionHeadersubclass) to be set on the section before it's added to theSectionStack. | 
| ImgSectionHeader | getHeaderPropertiesAsImgSectionHeader()Allows properties for the header (a  SectionHeaderorImgSectionHeadersubclass) to be set on the section before it's added to theSectionStack. | 
| java.lang.String | getIcon()Base filename of the icon that represents open and closed states. | 
| java.lang.String | getID()Optional ID for the section. | 
| Canvas[] | getItems()Return the items in this SectionStackSection | 
| java.lang.String | getName()Identifier for the section. | 
| static SectionStackSection | getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) | 
| SectionHeader | getSectionHeader()Once a SectionStackSection has been applied to a SectionStack, this method may be used to return  a pointer to the
 SectionHeader for this section | 
| SectionStack | getSectionStack() | 
| java.lang.Boolean | getShowClippedTitleOnHover()If true and the title is clipped, then a hover containing the full title of this section header is enabled. | 
| java.lang.String | getTitle()Title to show for the section | 
| void | setAriaRole(java.lang.String ariaRole)Specify the ariaRole for this SectionStackSection. | 
| void | setAriaState(java.lang.String stateName,
            java.lang.Object stateValue)Specify an ariaState for this SectionStackSection. | 
| SectionStackSection | setCanClose(java.lang.Boolean canClose)Is this section closeable? | 
| SectionStackSection | setCanCollapse(java.lang.Boolean canCollapse)This attribute controls whether or not the expand/collapse UI control is shown on the header of this section. | 
| SectionStackSection | setCanDropBefore(java.lang.Boolean canDropBefore)When explicitly set to false, disallows drop before this member in the Layout. | 
| SectionStackSection | setCanReorder(java.lang.Boolean canReorder)If set to false, then this sectionHeader will not be able to be dragged to perform a drag reorder, if  SectionStack.canReorderSectionsis true. | 
| SectionStackSection | setCanTabToHeader(java.lang.Boolean canTabToHeader)If true, the header for this Section will be included in the page's tab order for accessibility. | 
| SectionStackSection | setClipTitle(java.lang.Boolean clipTitle)If the title for this section header is too large for the available space, should the title be clipped? | 
| SectionStackSection | setCloseIcon(java.lang.String closeIcon)Icon src for the  close buttonifcanCloseis true. | 
| SectionStackSection | setCloseIconSize(java.lang.Integer closeIconSize)Pixel width/height for this sections  closeIcon.If unset SectionStack.closeSectionIconSizewill be used. | 
| SectionStackSection | setControls(Canvas... controls)Custom controls to be shown on top of this section header. | 
| SectionStackSection | setDestroyOnRemove(java.lang.Boolean destroyOnRemove) | 
| void | setExpanded(java.lang.Boolean expanded)Sections default to the collapsed state unless  showHeaderis set tofalsein which
 case they default to the expanded state. | 
| SectionStackSection | setHeaderProperties(ImgSectionHeader headerProperties)Allows properties for the header (a  SectionHeaderorImgSectionHeadersubclass) to be set on the section before it's added to theSectionStack. | 
| SectionStackSection | setHeaderProperties(SectionHeader headerProperties)Allows properties for the header (a  SectionHeaderorImgSectionHeadersubclass) to be set on the section before it's added to theSectionStack. | 
| void | setHidden(java.lang.Boolean hidden)Sections default to the visible state. | 
| SectionStackSection | setIcon(java.lang.String icon)Base filename of the icon that represents open and closed states. | 
| void | setID(java.lang.String ID)Optional ID for the section. | 
| void | setItems(Canvas... items)Assign a new set of Canvases to this section. | 
| SectionStackSection | setName(java.lang.String name)Identifier for the section. | 
| SectionStackSection | setResizeable(java.lang.Boolean resizeable)If set to false, then the items in this section will not be resized by sectionHeader repositioning. | 
| SectionStackSection | setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)If true and the title is clipped, then a hover containing the full title of this section header is enabled. | 
| SectionStackSection | setShowHeader(java.lang.Boolean showHeader)If true, a header will be shown for this section. | 
| void | setTitle(java.lang.String title)Title to show for the section | 
| void | setTitleHoverFormatter(TitleHoverFormatter formatter)Provide a custom implementation of  SectionHeader.titleHoverHTML(java.lang.String). | 
getRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedprotected SectionStack stack
public SectionStackSection()
public SectionStackSection(com.google.gwt.core.client.JavaScriptObject jsObj)
public SectionStackSection(java.lang.String title)
public static SectionStackSection getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public SectionStackSection setCanClose(java.lang.Boolean canClose)
 Closeable sections show a SectionStack.closeSectionButton which will invoke
 SectionStack.closeSection() when clicked. 
 This
 property overrides the default SectionStack.canCloseSections setting.
canClose - New canClose value. Default value is nullSectionStackSection instance, for chaining setter callspublic java.lang.Boolean getCanClose()
 Closeable sections show a SectionStack.closeSectionButton which will invoke
 SectionStack.closeSection() when clicked. 
 This
 property overrides the default SectionStack.canCloseSections setting.
public SectionStackSection setCanCollapse(java.lang.Boolean canCollapse)
canCollapse - New canCollapse value. Default value is trueSectionStackSection instance, for chaining setter callspublic SectionStackSection setCanDropBefore(java.lang.Boolean canDropBefore)
canDropBefore - New canDropBefore value. Default value is nullSectionStackSection instance, for chaining setter callsLayout, 
LayoutMember overview and related methodspublic SectionStackSection setCanReorder(java.lang.Boolean canReorder)
SectionStack.canReorderSections is true. You can
 also disable dropping other sections before this one by setting  canDropBefore to false.canReorder - New canReorder value. Default value is nullSectionStackSection instance, for chaining setter callspublic SectionStackSection setCanTabToHeader(java.lang.Boolean canTabToHeader)
SectionStack level via  SectionStack.canTabToHeaders.  See Accessibility.
canTabToHeader - New canTabToHeader value. Default value is nullSectionStackSection instance, for chaining setter callspublic java.lang.Boolean getCanTabToHeader()
SectionStack level via  SectionStack.canTabToHeaders.  See Accessibility.
public SectionStackSection setClipTitle(java.lang.Boolean clipTitle)
This feature is supported only in browsers that support the CSS UI text-overflow property (IE6+, Firefox 7+, Safari, Chrome, Opera 9+).
clipTitle - New clipTitle value. Default value is trueSectionStackSection instance, for chaining setter callspublic java.lang.Boolean getClipTitle()
This feature is supported only in browsers that support the CSS UI text-overflow property (IE6+, Firefox 7+, Safari, Chrome, Opera 9+).
public SectionStackSection setCloseIcon(java.lang.String closeIcon)
close button if  canClose is true.  If specified this takes
 precedence over SectionStack.closeSectionIcon.
closeIcon - New closeIcon value. Default value is nullSectionStackSection instance, for chaining setter callsSCImgURLpublic java.lang.String getCloseIcon()
close button if  canClose is true.  If specified this takes
 precedence over SectionStack.closeSectionIcon.
SCImgURLpublic SectionStackSection setCloseIconSize(java.lang.Integer closeIconSize)
closeIcon.SectionStack.closeSectionIconSize will be used.closeIconSize - New closeIconSize value. Default value is nullSectionStackSection instance, for chaining setter callspublic java.lang.Integer getCloseIconSize()
closeIcon.SectionStack.closeSectionIconSize will be used.public SectionStackSection setControls(Canvas... controls)
 These controls are shown in the SectionHeader.controlsLayout. 
Note that this is an init-time property. If you need to dynamically change what controls are displayed to the user, we would recommend embedding the controls in a Layout or similar container. This will allow you to show/hide or add/remove members at runtime by manipulating the existing control(s) set up at init time.
 For canClose:true sections, a close icon will be added to the section controls
 automatically.
controls - New controls value. Default value is nullSectionStackSection instance, for chaining setter callspublic Canvas[] getControls()
 These controls are shown in the SectionHeader.controlsLayout. 
Note that this is an init-time property. If you need to dynamically change what controls are displayed to the user, we would recommend embedding the controls in a Layout or similar container. This will allow you to show/hide or add/remove members at runtime by manipulating the existing control(s) set up at init time.
 For canClose:true sections, a close icon will be added to the section controls
 automatically.
public SectionStackSection setDestroyOnRemove(java.lang.Boolean destroyOnRemove)
items be destroyed if this section is removed?  The section header itself and any controls will
 always be destroyed.destroyOnRemove - New destroyOnRemove value. Default value is falseSectionStackSection instance, for chaining setter callspublic SectionStackSection setHeaderProperties(SectionHeader headerProperties)
SectionHeader or ImgSectionHeader subclass) to be set on the section before it's added to the SectionStack.headerProperties - New headerProperties value. Default value is nullSectionStackSection instance, for chaining setter callsSectionStack.setSectionHeaderClass(java.lang.String), 
SGWTPropertiespublic SectionHeader getHeaderProperties()
SectionHeader or ImgSectionHeader subclass) to be set on the section before it's added to the SectionStack.SectionStack.getSectionHeaderClass()public SectionStackSection setHeaderProperties(ImgSectionHeader headerProperties)
SectionHeader or ImgSectionHeader subclass) to be set on the section before it's added to the SectionStack.headerProperties - New headerProperties value. Default value is nullSectionStackSection instance, for chaining setter callsSectionStack.setSectionHeaderClass(java.lang.String), 
SGWTPropertiespublic ImgSectionHeader getHeaderPropertiesAsImgSectionHeader()
SectionHeader or ImgSectionHeader subclass) to be set on the section before it's added to the SectionStack.SectionStack.getSectionHeaderClass()public SectionStackSection setIcon(java.lang.String icon)
 Not shown if
 canCollapse is false.
icon - New icon value. Default value is "[SKIN]SectionHeader/opener.gif"SectionStackSection instance, for chaining setter callsSCImgURLpublic java.lang.String getIcon()
 Not shown if
 canCollapse is false.
SCImgURLpublic SectionStackSection setName(java.lang.String name)
SectionStack
 APIs such as SectionStack.expandSection() and
 SectionStack.collapseSection(). Note that if no
 name is specified for the section, one will be auto-generated when the section is created. This property should be a
 string which may be used as a valid JavaScript identifier (should start with a letter and not contain space or special
 characters such as "*").name - New name value. Default value is nullSectionStackSection instance, for chaining setter callspublic java.lang.String getName()
SectionStack
 APIs such as SectionStack.expandSection() and
 SectionStack.collapseSection(). Note that if no
 name is specified for the section, one will be auto-generated when the section is created. This property should be a
 string which may be used as a valid JavaScript identifier (should start with a letter and not contain space or special
 characters such as "*").public SectionStackSection setResizeable(java.lang.Boolean resizeable)
resizeable - New resizeable value. Default value is nullSectionStackSection instance, for chaining setter callspublic SectionStackSection setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)
showClippedTitleOnHover - New showClippedTitleOnHover value. Default value is trueSectionStackSection instance, for chaining setter callspublic java.lang.Boolean getShowClippedTitleOnHover()
public SectionStackSection setShowHeader(java.lang.Boolean showHeader)
showHeader - New showHeader value. Default value is trueSectionStackSection instance, for chaining setter callspublic void setTitle(java.lang.String title)
title - title Default value is nullpublic java.lang.String getTitle()
public void setExpanded(java.lang.Boolean expanded)
showHeader is set to false in which
 case they default to the expanded state.  This attribute allows you to explicitly control the expand/collapse state of
 the section by overriding the above default behavior.expanded - expanded Default value is falsepublic void setHidden(java.lang.Boolean hidden)
hidden - hidden Default value is falsepublic void setItems(Canvas... items)
items - list of Canvases that constitute the sectionpublic Canvas[] getItems()
public void addItem(Canvas item)
new - Canvas to add as itempublic SectionStack getSectionStack()
public SectionHeader getSectionHeader()
public java.lang.String getID()
useGlobalSectionIDs is true, this property will be applied to the generated
 SectionStackHeader widget as a standard widget ID, meaning it should be unique within a
 page.  Backcompat Note: Section stack sections may be uniquely identified
 within a stack via the name attribute
 (introduced in Jan 2010). Prior to this, the section ID attribute was used in this way
 (and would not be applied to the section header as a widget ID). For backwards
 compatibility this is still supported: If section.name is unspecified for a
 section but section.ID is set, the ID will be used as a default name
 attribute for the section. For backwards compatibility we also disable the standard
 behavior of having the section.ID being applied to the generated section
 header (thereby avoiding the page-level uniqueness requirement) by defaulting useGlobalSectionIDs to false.
public void setID(java.lang.String ID)
useGlobalSectionIDs is true, this property will be applied to the generated
 SectionStackHeader widget as a standard widget ID, meaning it should be unique within a
 page.  Backcompat Note: Section stack sections may be uniquely identified
 within a stack via the name attribute
 (introduced in Jan 2010). Prior to this, the section ID attribute was used in this way
 (and would not be applied to the section header as a widget ID). For backwards
 compatibility this is still supported: If section.name is unspecified for a
 section but section.ID is set, the ID will be used as a default name
 attribute for the section. For backwards compatibility we also disable the standard
 behavior of having the section.ID being applied to the generated section
 header (thereby avoiding the page-level uniqueness requirement) by defaulting useGlobalSectionIDs to false.
ID - ID Default value is nullpublic void setAriaRole(java.lang.String ariaRole)
AccessibilityariaRole - public void setAriaState(java.lang.String stateName,
                         java.lang.Object stateValue)
AccessibilitystateName - stateValue - public void setTitleHoverFormatter(TitleHoverFormatter formatter)
SectionHeader.titleHoverHTML(java.lang.String).