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

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.form.fields.FormItem
                  extended by com.smartgwt.client.widgets.form.fields.HeaderItem
All Implemented Interfaces:
HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, 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(String name)
           
HeaderItem(String name, String title)
           
 
Method Summary
 int getColSpan()
          by default, headers span all remaining columns
 String getDefaultValue()
          Header text
 Boolean getEndRow()
          these items are in a row by themselves by default
static HeaderItem getOrCreateRef(JavaScriptObject jsObj)
           
 Boolean getShowTitle()
          Don't show a separate title cell for headers
 Boolean getStartRow()
          these items are in a row by themselves by default
 String getTextBoxStyle()
          Base CSS class for this item
 void setColSpan(int colSpan)
          by default, headers span all remaining columns
 void setDefaultValue(String defaultValue)
          Header text
 void setEndRow(Boolean endRow)
          these items are in a row by themselves by default
 void setShowTitle(Boolean showTitle)
          Don't show a separate title cell for headers
 void setStartRow(Boolean startRow)
          these items are in a row by themselves by default
 void setTextBoxStyle(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, addTitleHoverHandler, blurItem, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getCellStyle, getConfig, getCriteriaField, getCriterion, getDataPath, getDateFormatter, getDefaultIconSrc, getDisabled, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEmptyDisplayValue, getEmptyValueIcon, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getGlobalTabIndex, getHeight, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getLeft, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPickerIconHeight, getPickerIconSrc, getPickerIconWidth, getPrompt, getRejectInvalidValueOnChange, getRequired, getRowSpan, getSelectOnFocus, getShouldSaveValue, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowValueIconOnly, getSuppressValueIcon, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleOrientation, getTitleStyle, getTooltip, getTop, getType, getValidateOnChange, getValue, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getWidth, getWrapTitle, hide, isCreated, isDisabled, isDrawn, redraw, setAccessKey, setAlign, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setCellStyle, setColSpan, setCriteriaField, setDataPath, setDateFormatter, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisplayField, 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, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconSrc, setPickerIconWidth, setPrompt, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRowSpan, setSelectOnFocus, setShouldSaveValue, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowValueIconOnly, setSuppressValueIcon, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleOrientation, setTitleStyle, setTooltip, setTop, setType, setValidateOnChange, setValidators, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, show, stopHover, updateState
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsIntArray, getAttributeAsMap, getAttributeAsObject, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, 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(String name)

HeaderItem

public HeaderItem(String name,
                  String title)
Method Detail

getOrCreateRef

public static HeaderItem getOrCreateRef(JavaScriptObject jsObj)

setDefaultValue

public void setDefaultValue(String defaultValue)
Header text

Overrides:
setDefaultValue in class FormItem
Parameters:
defaultValue - defaultValue Default value is "Header"

getDefaultValue

public String getDefaultValue()
Header text

Returns:
String

setShowTitle

public void setShowTitle(Boolean showTitle)
Don't show a separate title cell for headers

Overrides:
setShowTitle in class FormItem
Parameters:
showTitle - showTitle Default value is false

getShowTitle

public Boolean getShowTitle()
Don't show a separate title cell for headers

Overrides:
getShowTitle in class FormItem
Returns:
Boolean

setTextBoxStyle

public void setTextBoxStyle(String textBoxStyle)
Base CSS class for this item

Overrides:
setTextBoxStyle in class FormItem
Parameters:
textBoxStyle - textBoxStyle Default value is "headerItem"

getTextBoxStyle

public String getTextBoxStyle()
Base CSS class for this item

Overrides:
getTextBoxStyle in class FormItem
Returns:
String

setColSpan

public void setColSpan(int colSpan)
by default, headers span all remaining columns

Overrides:
setColSpan in class FormItem
Parameters:
colSpan - colSpan Default value is "*"

getColSpan

public int getColSpan()
by default, headers span all remaining columns

Returns:
int

setStartRow

public void setStartRow(Boolean startRow)
these items are in a row by themselves by default

Overrides:
setStartRow in class FormItem
Parameters:
startRow - startRow Default value is true

getStartRow

public Boolean getStartRow()
these items are in a row by themselves by default

Overrides:
getStartRow in class FormItem
Returns:
Boolean

setEndRow

public void setEndRow(Boolean endRow)
these items are in a row by themselves by default

Overrides:
setEndRow in class FormItem
Parameters:
endRow - endRow Default value is true

getEndRow

public Boolean getEndRow()
these items are in a row by themselves by default

Overrides:
getEndRow in class FormItem
Returns:
Boolean