com.smartgwt.client.widgets.grid
Class HeaderSpan

java.lang.Object
  com.smartgwt.client.core.JsObject
      com.smartgwt.client.core.DataClass
          com.smartgwt.client.widgets.grid.HeaderSpan

public class HeaderSpan
extends DataClass

A header span appears as a second level of headers in a ListGrid, spanning one or more ListGrid columns and their associated headers.

See headerSpans.

In addition to the properties documented here, all other properties specified on the headerSpan object will be passed to the create() method of the headerSpanConstructor. This allows you to set properties such as baseStyle or src directly in a headerSpan.

Field Summary

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

HeaderSpan()

HeaderSpan(JavaScriptObject jsObj)

HeaderSpan(String title, String[] fields)

Method Summary

Alignment	getAlign() Horizontal alignment of the title of this headerSpan.
String[]	getFields() List of fields that this header spans.
Integer	getHeight() Height of this headerSpan.
String	getName() Name for this headerSpan, for use in APIs like ListGrid.setHeaderSpanTitle.
static HeaderSpan	getOrCreateRef(JavaScriptObject jsObj)
String	getTitle() Title for this headerSpan.
VerticalAlignment	getValign() Vertical alignment of the title of this headerSpan.
void	setAlign(Alignment align) Horizontal alignment of the title of this headerSpan.
void	setFields(String... fields) List of fields that this header spans.
void	setHeight(Integer height) Height of this headerSpan.
void	setName(String name) Name for this headerSpan, for use in APIs like ListGrid.setHeaderSpanTitle.
void	setTitle(String title) Title for this headerSpan.
void	setValign(VerticalAlignment valign) Vertical alignment of the title of this headerSpan.

Methods inherited from class com.smartgwt.client.core.DataClass

doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, 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, 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

HeaderSpan

public HeaderSpan()

HeaderSpan

public HeaderSpan(JavaScriptObject jsObj)

HeaderSpan

public HeaderSpan(String title,
                  String[] fields)

Method Detail

getOrCreateRef

public static HeaderSpan getOrCreateRef(JavaScriptObject jsObj)

setAlign

public void setAlign(Alignment align)

Horizontal alignment of the title of this headerSpan.

Parameters:

align - align Default value is "center"

getAlign

public Alignment getAlign()

Horizontal alignment of the title of this headerSpan.

Returns:

Alignment

setFields

public void setFields(String... fields)

List of fields that this header spans. Fields should be identified by their value for name.

Parameters:

fields - fields Default value is null

getFields

public String[] getFields()

List of fields that this header spans. Fields should be identified by their value for name.

Returns:

String

setHeight

public void setHeight(Integer height)

Height of this headerSpan. Defaults to headerSpanHeight.

Parameters:

height - height Default value is null

getHeight

public Integer getHeight()

Height of this headerSpan. Defaults to headerSpanHeight.

Returns:

Integer

setName

public void setName(String name)

Name for this headerSpan, for use in APIs like ListGrid.setHeaderSpanTitle.

Name is optional, but if specified, must be unique for this ListGrid (but not globally unique).

Parameters:

name - name Default value is null

getName

public String getName()

Name for this headerSpan, for use in APIs like ListGrid.setHeaderSpanTitle.

Name is optional, but if specified, must be unique for this ListGrid (but not globally unique).

Returns:

String

setTitle

public void setTitle(String title)

Title for this headerSpan.

Parameters:

title - title Default value is null

getTitle

public String getTitle()

Title for this headerSpan.

Returns:

String

setValign

public void setValign(VerticalAlignment valign)

Vertical alignment of the title of this headerSpan.

Defaults to listGrid.headerSpanVAlign if unset.

Parameters:

valign - valign Default value is null

getValign

public VerticalAlignment getValign()

Vertical alignment of the title of this headerSpan.

Defaults to listGrid.headerSpanVAlign if unset.

Returns:

VerticalAlignment