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

See ListGrid.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 ListGrid.headerSpanConstructor. This allows you to set properties such as Button.baseStyle or StretchImgButton.src directly in a headerSpan.

setHeaderTitle

public void setHeaderTitle(java.lang.String headerTitle)

Optional title for the headerSpan button for this headerSpan. If specified this will be displayed in the headerSpan
button instead of title. Set to an empty string to suppress
the title in the header button entirely.

Parameters:

headerTitle - New headerTitle value. Default value is null

getHeaderTitle

public java.lang.String getHeaderTitle()

Optional title for the headerSpan button for this headerSpan. If specified this will be displayed in the headerSpan
button instead of title. Set to an empty string to suppress
the title in the header button entirely.

setName

Name is optional, but if specified, must be unique for this ListGrid (but not
globally unique) as well as a valid JavaScript identifier, as specified by ECMA-262 Section 7.6 (the
StringUtil.isValidID() function can be used to test whether a name is a valid JavaScript identifier).

getName

Name is optional, but if specified, must be unique for this ListGrid (but not
globally unique) as well as a valid JavaScript identifier, as specified by ECMA-262 Section 7.6 (the
StringUtil.isValidID() function can be used to test whether a name is a valid JavaScript identifier).

setTitle

public void setTitle(java.lang.String title)

A title for this headerSpan, to display in the headerSpan button for this headerSpan and in other contexts such as the
menu for picking visible fields. Note: if you want to
use HTML tags to affect the display of the header, you should do so via headerTitle instead so that other places where the title
appears in the UI are not affected. Refer to discussion at ListGridField.title.

Parameters:

title - New title value. Default value is null

getTitle

public java.lang.String getTitle()

A title for this headerSpan, to display in the headerSpan button for this headerSpan and in other contexts such as the
menu for picking visible fields. Note: if you want to
use HTML tags to affect the display of the header, you should do so via headerTitle instead so that other places where the title
appears in the UI are not affected. Refer to discussion at ListGridField.title.

getValign

setWrap

public void setWrap(java.lang.Boolean wrap)

Should the span title wrap if there is not enough space horizontally to accommodate it. If unset, default behavior is
derived from ListGrid.wrapHeaderSpanTitles.
(This is a soft-wrap - if set the title will wrap at word boundaries.)

getWrap

public java.lang.Boolean getWrap()

Should the span title wrap if there is not enough space horizontally to accommodate it. If unset, default behavior is
derived from ListGrid.wrapHeaderSpanTitles.
(This is a soft-wrap - if set the title will wrap at word boundaries.)

setHeaderButtonProperties

Set the properties of the header button used for this span.
The buttonProperties parameter should be the same class as the headerButtonConstructor for
the ListGrid (most commonly Button, ImgButton or StretchImgButton, and typically set up
in the load_skin.js file for the loaded theme).