com.smartgwt.client.widgets.form.fields
Class HeaderItem

java.lang.Object
  com.smartgwt.client.core.JsObject
      com.smartgwt.client.core.DataClass
          com.smartgwt.client.core.RefDataClass
              com.smartgwt.client.widgets.form.fields.FormItem
                  com.smartgwt.client.widgets.form.fields.HeaderItem

All Implemented Interfaces:

HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers

public class HeaderItem
extends FormItem

FormItem for showing a header within a DynamicForm.

Set the defaultValue of this item to the HTML you want to embed in the form.

Field Summary

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

jsObj

Constructor Summary

HeaderItem()

HeaderItem(JavaScriptObject jsObj)

HeaderItem(java.lang.String name)

HeaderItem(java.lang.String name, java.lang.String title)

Method Summary

int	getColSpan() by default, headers span all remaining columns
java.lang.String	getDefaultValue() Header text
java.lang.Boolean	getEndRow() these items are in a row by themselves by default
static HeaderItem	getOrCreateRef(JavaScriptObject jsObj)
java.lang.Boolean	getShowTitle() Don't show a separate title cell for headers
java.lang.Boolean	getStartRow() these items are in a row by themselves by default
java.lang.String	getTextBoxStyle() Base CSS class for this item
void	setColSpan(int colSpan) by default, headers span all remaining columns
void	setDefaultValue(java.lang.String defaultValue) Header text
void	setEndRow(java.lang.Boolean endRow) these items are in a row by themselves by default
void	setShowTitle(java.lang.Boolean showTitle) Don't show a separate title cell for headers
void	setStartRow(java.lang.Boolean startRow) these items are in a row by themselves by default
void	setTextBoxStyle(java.lang.String textBoxStyle) Base CSS class for this item

Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem

addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, blurItem, canEditCriterion, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanFocus, getCellHeight, getCellStyle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDefaultIconSrc, getDisabled, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEmptyDisplayValue, getEmptyValueIcon, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFullDataPath, getGlobalTabIndex, getHeight, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPickerIconHeight, getPickerIconName, getPickerIconSrc, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getRect, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSelectedRecord, getSelectOnFocus, getShouldSaveValue, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowValueIconOnly, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getValue, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWrapTitle, hasAdvancedCriteria, hide, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBrowserSpellCheck, setCanFocus, setCellHeight, setCellStyle, setColSpan, setCriteriaField, setCriterion, setDataPath, setDateFormatter, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorType, setEditorValueFormatter, setEditorValueParser, setEmptyDisplayValue, setEmptyValueIcon, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconSrc, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSelectOnFocus, setShouldSaveValue, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowValueIconOnly, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldFetchMissingValue, show, showPicker, stopHover, updateState, validate

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

getRef, getRef

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

doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute

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

setJsObj

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

HeaderItem

public HeaderItem()

HeaderItem

public HeaderItem(JavaScriptObject jsObj)

HeaderItem

public HeaderItem(java.lang.String name)

HeaderItem

public HeaderItem(java.lang.String name,
                  java.lang.String title)

Method Detail

getOrCreateRef

public static HeaderItem getOrCreateRef(JavaScriptObject jsObj)

setColSpan

public void setColSpan(int colSpan)

by default, headers span all remaining columns

Overrides:

setColSpan in class FormItem

Parameters:

colSpan - colSpan Default value is "*"

See Also:

Appearance overview and related methods

getColSpan

public int getColSpan()

by default, headers span all remaining columns

Returns:

int

See Also:

Appearance overview and related methods

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Header text

Overrides:

setDefaultValue in class FormItem

Parameters:

defaultValue - defaultValue Default value is "Header"

See Also:

Appearance overview and related methods

getDefaultValue

public java.lang.String getDefaultValue()

Header text

Returns:

String

See Also:

Appearance overview and related methods

setEndRow

public void setEndRow(java.lang.Boolean endRow)

these items are in a row by themselves by default

Overrides:

setEndRow in class FormItem

Parameters:

endRow - endRow Default value is true

See Also:

Appearance overview and related methods

getEndRow

public java.lang.Boolean getEndRow()

these items are in a row by themselves by default

Overrides:

getEndRow in class FormItem

Returns:

Boolean

See Also:

Appearance overview and related methods

setShowTitle

public void setShowTitle(java.lang.Boolean showTitle)

Don't show a separate title cell for headers

Overrides:

setShowTitle in class FormItem

Parameters:

showTitle - showTitle Default value is false

See Also:

Appearance overview and related methods

getShowTitle

public java.lang.Boolean getShowTitle()

Don't show a separate title cell for headers

Overrides:

getShowTitle in class FormItem

Returns:

Boolean

See Also:

Appearance overview and related methods

setStartRow

public void setStartRow(java.lang.Boolean startRow)

these items are in a row by themselves by default

Overrides:

setStartRow in class FormItem

Parameters:

startRow - startRow Default value is true

See Also:

Appearance overview and related methods

getStartRow

public java.lang.Boolean getStartRow()

these items are in a row by themselves by default

Overrides:

getStartRow in class FormItem

Returns:

Boolean

See Also:

Appearance overview and related methods

setTextBoxStyle

public void setTextBoxStyle(java.lang.String textBoxStyle)

Base CSS class for this item

Overrides:

setTextBoxStyle in class FormItem

Parameters:

textBoxStyle - textBoxStyle Default value is "headerItem"

See Also:

Appearance overview and related methods

getTextBoxStyle

public java.lang.String getTextBoxStyle()

Base CSS class for this item

Overrides:

getTextBoxStyle in class FormItem

Returns:

String

See Also:

Appearance overview and related methods