com.smartgwt.client.widgets.layout
Class SectionStackSection

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.core.RefDataClass
              extended by com.smartgwt.client.widgets.layout.SectionStackSection

public class SectionStackSection
extends RefDataClass

Section descriptor used by a SectionStack to describe a section of items which are shown or hidden together, and their associated header.


Field Summary
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
SectionStackSection()
           
SectionStackSection(com.google.gwt.core.client.JavaScriptObject jsObj)
           
SectionStackSection(java.lang.String title)
           
 
Method Summary
 void addItem(Canvas item)
           
 java.lang.String getID()
          Optional ID for the section.
static SectionStackSection getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.String getTitle()
          Title to show for the section
 void setCanCollapse(java.lang.Boolean canCollapse)
          This attribute controls whether or not the expand/collapse UI control is shown on the header of this section.
 void setControls(Canvas... controls)
           
 void setExpanded(java.lang.Boolean expanded)
          Sections default to the collapsed state unless showHeader is set to false in which case they default to the expanded state.
 void setHidden(java.lang.Boolean hidden)
          Sections default to the visible state.
 void setID(java.lang.String ID)
          Optional ID for the section.
 void setItems(Canvas... items)
          List of Canvases that constitute the section.
 void setResizeable(java.lang.Boolean resizeable)
          If set to false, then the items in this section will not be resized by sectionHeader repositioning.
 void 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
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 
Methods inherited from class com.smartgwt.client.core.JsObject
isCreated, setJsObj
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SectionStackSection

public SectionStackSection()

SectionStackSection

public SectionStackSection(com.google.gwt.core.client.JavaScriptObject jsObj)

SectionStackSection

public SectionStackSection(java.lang.String title)
Method Detail

getOrCreateRef

public static SectionStackSection getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setID

public void setID(java.lang.String ID)
Optional ID for the section. This can be used later in calls to SectionStack APIs such as SectionStack.expandSection(int) and SectionStack.collapseSection(int).

Parameters:
ID - ID Default value is null

getID

public java.lang.String getID()
Optional ID for the section. This can be used later in calls to SectionStack APIs such as SectionStack.expandSection(int) and SectionStack.collapseSection(int).

Returns:
String

setTitle

public void setTitle(java.lang.String title)
Title to show for the section

Parameters:
title - title Default value is null

getTitle

public java.lang.String getTitle()
Title to show for the section

Returns:
String

setShowHeader

public void setShowHeader(java.lang.Boolean showHeader)
If true, a header will be shown for this section. If false, no header will be shown.

Parameters:
showHeader - showHeader Default value is true

setResizeable

public void setResizeable(java.lang.Boolean resizeable)
If set to false, then the items in this section will not be resized by sectionHeader repositioning. You may also set this flag directly on any of the items in any section to cause that item to not be resizeable.

Parameters:
resizeable - resizeable Default value is null

setExpanded

public void setExpanded(java.lang.Boolean expanded)
Sections default to the collapsed state unless 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.

Parameters:
expanded - expanded Default value is false

setHidden

public void setHidden(java.lang.Boolean hidden)
Sections default to the visible state. This attribute allows you to explicitly control the visible/hidden state of the section by overriding the above default behavior.

Parameters:
hidden - hidden Default value is false

setCanCollapse

public void setCanCollapse(java.lang.Boolean canCollapse)
This attribute controls whether or not the expand/collapse UI control is shown on the header of this section. Any section can still be expanded/collapsed programmatically, regardless of this setting.

Parameters:
canCollapse - canCollapse Default value is true

setItems

public void setItems(Canvas... items)
List of Canvases that constitute the section. These Canvases will be shown and hidden together.

Parameters:
items - list of Canvases that constitute the section

addItem

public void addItem(Canvas item)

setControls

public void setControls(Canvas... controls)