public class CheckboxItem extends FormItem
FormItem.CustomStateGetter, FormItem.StateCustomizer
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault
id
factoryCreated, factoryProperties
Constructor and Description |
---|
CheckboxItem() |
CheckboxItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
CheckboxItem(java.lang.String name) |
CheckboxItem(java.lang.String name,
java.lang.String title) |
Modifier and Type | Method and Description |
---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
java.lang.Boolean |
getAllowEmptyValue()
By default checkboxes allow the user to toggle between true and false values only.
|
java.lang.String |
getBooleanBaseStyle()
An optional base CSS style to apply to the checkbox image.
|
java.lang.String |
getCheckedDescription()
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the checked state. |
java.lang.String |
getCheckedImage()
URL for the image to display when this checkbox is selected, or checked.
|
java.lang.Boolean |
getDefaultValue()
Overridden to assign class-appropriate type.
|
java.lang.String |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
java.lang.Boolean |
getLabelAsTitle()
By default a checkboxItem sets
showTitle :true,
and so takes up two cells with the default TitleOrientation of "left" (see form layout\n overview ). |
static CheckboxItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getPartialSelectedDescription()
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the partial selected state. |
java.lang.String |
getPartialSelectedImage()
URL for the image to display when this checkbox is partially selected.
|
java.lang.String |
getPrintBooleanBaseStyle()
If set, the
booleanBaseStyle to use
when printing . |
java.lang.String |
getPrintCheckedImage()
If set, the
checkedImage to use when printing . |
java.lang.String |
getPrintPartialSelectedImage()
If set, the
partialSelectedImage to
use when printing . |
java.lang.String |
getPrintUncheckedImage()
If set, the
uncheckedImage to use when
printing . |
java.lang.String |
getPrintUnsetImage()
If set, the
unsetImage to use when printing . |
java.lang.Boolean |
getShowLabel()
Should we show the label text next to the checkbox item.
|
java.lang.Boolean |
getShowNullAsTrue()
Should a null value be shown as checked (i.e.
|
java.lang.String |
getShowNullAsTrueIf()
Set this property to the name of another field in the same record, to have this field be shown as checked (i.e.
|
java.lang.Boolean |
getShowTitle()
CheckboxItem has special behavior for titles, see
labelAsTitle . |
java.lang.Boolean |
getShowValueIconDisabled()
Should a "Disabled" state icon be shown when the item is disabled
|
java.lang.Boolean |
getShowValueIconDown()
Should a "Down" state icon be shown when the mouse goes down over this checkbox
|
java.lang.Boolean |
getShowValueIconError()
Whether a separate "Error" state should be applied to icons when the item fails validation.
|
java.lang.Boolean |
getShowValueIconOver()
Should an "Over" state icon be shown when the user rolls over this checkbox
|
boolean |
getSizeToCheckboxImage()
If this checkbox item is
not showing a label ,
should it ignore any specified FormItem.width and
instead size to fit its checkbox icon ? |
java.lang.String |
getTextBoxStyle()
Base CSS class for this item's title text
|
java.lang.String |
getTitleStyle()
Base CSS class for this item's title cell.
|
java.lang.String |
getUncheckedDescription()
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the unchecked state. |
java.lang.String |
getUncheckedImage()
URL for the image to display when this checkbox is not selected, or unchecked.
|
java.lang.String |
getUnsetDescription()
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the unset state. |
java.lang.String |
getUnsetImage()
URL for the image to display when this checkbox is unset.
|
java.lang.Boolean |
getValueAsBoolean()
Return the value of the checkbox as a Boolean.
|
int |
getWidth()
Width for the CheckboxItem, including both checkbox image and
label . |
boolean |
pendingStatusChanged(DynamicForm form,
FormItem item,
boolean pendingStatus,
java.lang.Object newValue,
java.lang.Object value)
Notification method called when
showPending is
enabled and this checkbox item should either clear or show its pending visual state. |
CheckboxItem |
setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
By default checkboxes allow the user to toggle between true and false values only.
|
CheckboxItem |
setBooleanBaseStyle(java.lang.String booleanBaseStyle)
An optional base CSS style to apply to the checkbox image.
|
CheckboxItem |
setCheckedDescription(java.lang.String checkedDescription)
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the checked state. |
CheckboxItem |
setCheckedImage(java.lang.String checkedImage)
URL for the image to display when this checkbox is selected, or checked.
|
static void |
setDefaultProperties(CheckboxItem checkboxItemProperties)
Class level method to set the default properties of this class.
|
CheckboxItem |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode . |
CheckboxItem |
setLabelAsTitle(java.lang.Boolean labelAsTitle)
By default a checkboxItem sets
showTitle :true,
and so takes up two cells with the default TitleOrientation of "left" (see form layout\n overview ). |
CheckboxItem |
setPartialSelectedDescription(java.lang.String partialSelectedDescription)
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the partial selected state. |
CheckboxItem |
setPartialSelectedImage(java.lang.String partialSelectedImage)
URL for the image to display when this checkbox is partially selected.
|
CheckboxItem |
setPrintBooleanBaseStyle(java.lang.String printBooleanBaseStyle)
If set, the
booleanBaseStyle to use
when printing . |
CheckboxItem |
setPrintCheckedImage(java.lang.String printCheckedImage)
If set, the
checkedImage to use when printing . |
CheckboxItem |
setPrintPartialSelectedImage(java.lang.String printPartialSelectedImage)
If set, the
partialSelectedImage to
use when printing . |
CheckboxItem |
setPrintUncheckedImage(java.lang.String printUncheckedImage)
If set, the
uncheckedImage to use when
printing . |
CheckboxItem |
setPrintUnsetImage(java.lang.String printUnsetImage)
If set, the
unsetImage to use when printing . |
CheckboxItem |
setShowLabel(java.lang.Boolean showLabel)
Should we show the label text next to the checkbox item.
|
CheckboxItem |
setShowNullAsTrue(java.lang.Boolean showNullAsTrue)
Should a null value be shown as checked (i.e.
|
CheckboxItem |
setShowNullAsTrueIf(java.lang.String showNullAsTrueIf)
Set this property to the name of another field in the same record, to have this field be shown as checked (i.e.
|
CheckboxItem |
setShowTitle(java.lang.Boolean showTitle)
CheckboxItem has special behavior for titles, see
labelAsTitle . |
void |
setShowUnsetImage(java.lang.Boolean showUnsetImage)
Determines what image to display when the value for this checkbox is unset.
|
CheckboxItem |
setShowValueIconDisabled(java.lang.Boolean showValueIconDisabled)
Should a "Disabled" state icon be shown when the item is disabled
|
CheckboxItem |
setShowValueIconDown(java.lang.Boolean showValueIconDown)
Should a "Down" state icon be shown when the mouse goes down over this checkbox
|
CheckboxItem |
setShowValueIconError(java.lang.Boolean showValueIconError)
Whether a separate "Error" state should be applied to icons when the item fails validation.
|
CheckboxItem |
setShowValueIconOver(java.lang.Boolean showValueIconOver)
Should an "Over" state icon be shown when the user rolls over this checkbox
|
CheckboxItem |
setSizeToCheckboxImage(boolean sizeToCheckboxImage)
If this checkbox item is
not showing a label ,
should it ignore any specified FormItem.width and
instead size to fit its checkbox icon ? |
CheckboxItem |
setTextBoxStyle(java.lang.String textBoxStyle)
Base CSS class for this item's title text
|
CheckboxItem |
setTitleStyle(java.lang.String titleStyle)
Base CSS class for this item's title cell.
|
CheckboxItem |
setUncheckedDescription(java.lang.String uncheckedDescription)
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the unchecked state. |
CheckboxItem |
setUncheckedImage(java.lang.String uncheckedImage)
URL for the image to display when this checkbox is not selected, or unchecked.
|
CheckboxItem |
setUnsetDescription(java.lang.String unsetDescription)
The description shown in a hover when
FormItem.showOldValueInHover is enabled and a value represents the unset state. |
CheckboxItem |
setUnsetImage(java.lang.String unsetImage)
URL for the image to display when this checkbox is unset.
|
CheckboxItem |
setWidth(int width)
Width for the CheckboxItem, including both checkbox image and
label . |
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIcon, addIcon, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, checkFormItemType, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanHover, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconProperties, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getEscapeHTML, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconBaseStyle, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLinearColSpan, getLinearColSpanAsString, getLinearEndRow, getLinearEndRowAsString, getLinearStartRow, getLinearStartRowAsString, getLinearWidth, getLinearWidthAsString, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultiple, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyCanSelectText, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorIconInline, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowIconsOnFocus, getShowImageAsURL, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowPickerIcon, getShowPickerIconOnFocus, getShowRTL, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getStoreDisplayValues, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsFloat, getValueAsInteger, getValueAsLong, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidthAsString, getWrapHintText, getWrapTitle, handleWarnOnEditorTypeConversion, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, setApplyAlignToText, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setAutoCompleteKeywords, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconBaseStyle, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLinearColSpan, setLinearColSpan, setLinearEndRow, setLinearEndRow, setLinearStartRow, setLinearStartRow, setLinearWidth, setLinearWidth, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultiple, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorIconInline, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIconsOnFocus, setShowIfCondition, setShowImageAsURL, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowPickerIcon, setShowPickerIconOnFocus, setShowRTL, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setStoreDisplayValues, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setUseObjectFactoryForTypeFallback, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setVisibleWhen, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWrapHintText, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClipped
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public CheckboxItem()
public CheckboxItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public CheckboxItem(java.lang.String name)
public CheckboxItem(java.lang.String name, java.lang.String title)
public static CheckboxItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties
.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public CheckboxItem setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
true
, false
and unset.allowEmptyValue
- New allowEmptyValue value. Default value is falseCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getAllowEmptyValue()
true
, false
and unset.public CheckboxItem setBooleanBaseStyle(java.lang.String booleanBaseStyle)
Note : This is an advanced setting
booleanBaseStyle
- New booleanBaseStyle value. Default value is nullCheckboxItem
instance, for chaining setter callssetPrintBooleanBaseStyle(java.lang.String)
,
CSSStyleName
public java.lang.String getBooleanBaseStyle()
getPrintBooleanBaseStyle()
,
CSSStyleName
public CheckboxItem setCheckedDescription(java.lang.String checkedDescription)
FormItem.showOldValueInHover
is enabled and a value represents the checked state.
Note : This is an advanced setting
checkedDescription
- New checkedDescription value. Default value is "checked"CheckboxItem
instance, for chaining setter callsHTMLString
public java.lang.String getCheckedDescription()
FormItem.showOldValueInHover
is enabled and a value represents the checked state.HTMLString
public CheckboxItem setCheckedImage(java.lang.String checkedImage)
This image is implemented using the valueIcons subsystem
, and may be modified via the
standard valueIcons properties such as valueIconWidth
Note that this is the base image name - if showValueIconOver
et al are set, the state
("Over"
, "Down"
and "Disabled"
) will be added to this name as the user interacts
with the checkbox, as well as the image extension
The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting this property to a SCSpriteConfig
formatted string. Alternatively developers can omit this property and instead
use CSS directly in the booleanBaseStyle
property to provide a "checked" appearance.
checkedImage
- New checkedImage value. Default value is "[SKIN]/DynamicForm/checked.gif"CheckboxItem
instance, for chaining setter callssetPrintCheckedImage(java.lang.String)
,
SCImgURL
,
Appearance overview and related methods
public java.lang.String getCheckedImage()
This image is implemented using the valueIcons subsystem
, and may be modified via the
standard valueIcons properties such as valueIconWidth
Note that this is the base image name - if showValueIconOver
et al are set, the state
("Over"
, "Down"
and "Disabled"
) will be added to this name as the user interacts
with the checkbox, as well as the image extension
The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting this property to a SCSpriteConfig
formatted string. Alternatively developers can omit this property and instead
use CSS directly in the booleanBaseStyle
property to provide a "checked" appearance.
getPrintCheckedImage()
,
SCImgURL
,
Appearance overview and related methods
public java.lang.Boolean getDefaultValue()
getDefaultValue
in class FormItem
FormItem.getDefaultValue()
public CheckboxItem setEditProxyConstructor(java.lang.String editProxyConstructor)
EditProxy
for this component when the component is
first placed into edit mode
.setEditProxyConstructor
in class FormItem
editProxyConstructor
- New editProxyConstructor value. Default value is "CheckboxItemEditProxy"CheckboxItem
instance, for chaining setter callsSCClassName
public java.lang.String getEditProxyConstructor()
EditProxy
for this component when the component is
first placed into edit mode
.getEditProxyConstructor
in class FormItem
SCClassName
public CheckboxItem setLabelAsTitle(java.lang.Boolean labelAsTitle)
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see form layout\n overview
). However, the title cell is left blank by default, and the
title specified by FormItem.title
is shown inside the
formItem's cell instead, in an element called the "label". To instead show the title in it's original location, set
labelAsTitle:true
. You can also set showLabel
:false to suppress the label and/or title
altogether.
labelAsTitle
- New labelAsTitle value. Default value is nullCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getLabelAsTitle()
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see form layout\n overview
). However, the title cell is left blank by default, and the
title specified by FormItem.title
is shown inside the
formItem's cell instead, in an element called the "label". To instead show the title in it's original location, set
labelAsTitle:true
. You can also set showLabel
:false to suppress the label and/or title
altogether.
public CheckboxItem setPartialSelectedDescription(java.lang.String partialSelectedDescription)
FormItem.showOldValueInHover
is enabled and a value represents the partial selected state.
Note : This is an advanced setting
partialSelectedDescription
- New partialSelectedDescription value. Default value is "partially selected"CheckboxItem
instance, for chaining setter callsHTMLString
public java.lang.String getPartialSelectedDescription()
FormItem.showOldValueInHover
is enabled and a value represents the partial selected state.HTMLString
public CheckboxItem setPartialSelectedImage(java.lang.String partialSelectedImage)
The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting this
property to a SCSpriteConfig
formatted string. Alternatively developers can omit this
property and instead use CSS directly in the booleanBaseStyle
property to provide a
"partially checked" appearance.
partialSelectedImage
- New partialSelectedImage value. Default value is "[SKIN]/DynamicForm/partialcheck.gif"CheckboxItem
instance, for chaining setter callssetPrintPartialSelectedImage(java.lang.String)
,
SCImgURL
,
Appearance overview and related methods
public java.lang.String getPartialSelectedImage()
The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting this
property to a SCSpriteConfig
formatted string. Alternatively developers can omit this
property and instead use CSS directly in the booleanBaseStyle
property to provide a
"partially checked" appearance.
getPrintPartialSelectedImage()
,
SCImgURL
,
Appearance overview and related methods
public CheckboxItem setPrintBooleanBaseStyle(java.lang.String printBooleanBaseStyle)
printBooleanBaseStyle
- New printBooleanBaseStyle value. Default value is nullCheckboxItem
instance, for chaining setter callssetBooleanBaseStyle(java.lang.String)
,
CSSStyleName
,
Printing
public java.lang.String getPrintBooleanBaseStyle()
booleanBaseStyle
to use
when printing
.getBooleanBaseStyle()
,
CSSStyleName
,
Printing
public CheckboxItem setPrintCheckedImage(java.lang.String printCheckedImage)
checkedImage
to use when printing
.printCheckedImage
- New printCheckedImage value. Default value is nullCheckboxItem
instance, for chaining setter callssetCheckedImage(java.lang.String)
,
SCImgURL
,
Printing
public java.lang.String getPrintCheckedImage()
checkedImage
to use when printing
.getCheckedImage()
,
SCImgURL
,
Printing
public CheckboxItem setPrintPartialSelectedImage(java.lang.String printPartialSelectedImage)
partialSelectedImage
to
use when printing
.printPartialSelectedImage
- New printPartialSelectedImage value. Default value is nullCheckboxItem
instance, for chaining setter callssetPartialSelectedImage(java.lang.String)
,
SCImgURL
,
Printing
public java.lang.String getPrintPartialSelectedImage()
partialSelectedImage
to
use when printing
.getPartialSelectedImage()
,
SCImgURL
,
Printing
public CheckboxItem setPrintUncheckedImage(java.lang.String printUncheckedImage)
uncheckedImage
to use when
printing
.printUncheckedImage
- New printUncheckedImage value. Default value is nullCheckboxItem
instance, for chaining setter callssetUncheckedImage(java.lang.String)
,
SCImgURL
,
Printing
public java.lang.String getPrintUncheckedImage()
uncheckedImage
to use when
printing
.getUncheckedImage()
,
SCImgURL
,
Printing
public CheckboxItem setPrintUnsetImage(java.lang.String printUnsetImage)
unsetImage
to use when printing
.printUnsetImage
- New printUnsetImage value. Default value is nullCheckboxItem
instance, for chaining setter callssetUnsetImage(java.lang.String)
,
SCImgURL
,
Printing
public java.lang.String getPrintUnsetImage()
unsetImage
to use when printing
.getUnsetImage()
,
SCImgURL
,
Printing
public CheckboxItem setShowLabel(java.lang.Boolean showLabel)
showLabel
- New showLabel value. Default value is trueCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getShowLabel()
public CheckboxItem setShowNullAsTrue(java.lang.Boolean showNullAsTrue)
showNullAsTrue
- New showNullAsTrue value. Default value is falseCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getShowNullAsTrue()
public CheckboxItem setShowNullAsTrueIf(java.lang.String showNullAsTrueIf)
showNullAsTrueIf
- New showNullAsTrueIf value. Default value is nullCheckboxItem
instance, for chaining setter callspublic java.lang.String getShowNullAsTrueIf()
public CheckboxItem setShowTitle(java.lang.Boolean showTitle)
labelAsTitle
.setShowTitle
in class FormItem
showTitle
- New showTitle value. Default value is trueCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getShowTitle()
labelAsTitle
.getShowTitle
in class FormItem
public CheckboxItem setShowValueIconDisabled(java.lang.Boolean showValueIconDisabled)
Note : This is an advanced setting
showValueIconDisabled
- New showValueIconDisabled value. Default value is trueCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getShowValueIconDisabled()
public CheckboxItem setShowValueIconDown(java.lang.Boolean showValueIconDown)
Note : This is an advanced setting
showValueIconDown
- New showValueIconDown value. Default value is trueCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getShowValueIconDown()
public CheckboxItem setShowValueIconError(java.lang.Boolean showValueIconError)
Over
or Disabled
, these are appended - for
example, ErrorOver or ErrorDisabled. Note that valid images must be made available for these
Error
states.
Note : This is an advanced setting
showValueIconError
- New showValueIconError value. Default value is falseCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getShowValueIconError()
Over
or Disabled
, these are appended - for
example, ErrorOver or ErrorDisabled. Note that valid images must be made available for these
Error
states.
public CheckboxItem setShowValueIconOver(java.lang.Boolean showValueIconOver)
Note : This is an advanced setting
showValueIconOver
- New showValueIconOver value. Default value is trueCheckboxItem
instance, for chaining setter callspublic java.lang.Boolean getShowValueIconOver()
public CheckboxItem setSizeToCheckboxImage(boolean sizeToCheckboxImage)
not showing a label
,
should it ignore any specified FormItem.width
and
instead size to fit its checkbox icon
? When set to true (the default), the checkbox item ignores any specified width, ensuring that it does not impact the the containing DynamicForm's table geometry unnecessarily.
Note : This is an advanced setting
sizeToCheckboxImage
- New sizeToCheckboxImage value. Default value is trueCheckboxItem
instance, for chaining setter callspublic boolean getSizeToCheckboxImage()
not showing a label
,
should it ignore any specified FormItem.width
and
instead size to fit its checkbox icon
? When set to true (the default), the checkbox item ignores any specified width, ensuring that it does not impact the the containing DynamicForm's table geometry unnecessarily.
public CheckboxItem setTextBoxStyle(java.lang.String textBoxStyle)
setTextBoxStyle
in class FormItem
textBoxStyle
- New textBoxStyle value. Default value is "labelAnchor"CheckboxItem
instance, for chaining setter callsFormItemBaseStyle
,
Appearance overview and related methods
public java.lang.String getTextBoxStyle()
getTextBoxStyle
in class FormItem
FormItemBaseStyle
,
Appearance overview and related methods
public CheckboxItem setTitleStyle(java.lang.String titleStyle)
Note: This styling applies to the standard form item title cell
for this item - it does not apply to item's label
. To modify the styling for that text, use textBoxStyle
instead.
setTitleStyle
in class FormItem
titleStyle
- New titleStyle value. Default value is nullCheckboxItem
instance, for chaining setter callsFormItemBaseStyle
,
Appearance overview and related methods
public java.lang.String getTitleStyle()
Note: This styling applies to the standard form item title cell
for this item - it does not apply to item's label
. To modify the styling for that text, use textBoxStyle
instead.
getTitleStyle
in class FormItem
FormItemBaseStyle
,
Appearance overview and related methods
public CheckboxItem setUncheckedDescription(java.lang.String uncheckedDescription)
FormItem.showOldValueInHover
is enabled and a value represents the unchecked state.
Note : This is an advanced setting
uncheckedDescription
- New uncheckedDescription value. Default value is "unchecked"CheckboxItem
instance, for chaining setter callsHTMLString
public java.lang.String getUncheckedDescription()
FormItem.showOldValueInHover
is enabled and a value represents the unchecked state.HTMLString
public CheckboxItem setUncheckedImage(java.lang.String uncheckedImage)
The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting
this property to a SCSpriteConfig
formatted string. Alternatively developers can omit
this property and instead use CSS directly in the booleanBaseStyle
property to provide an
"unchecked" appearance.
uncheckedImage
- New uncheckedImage value. Default value is "[SKIN]/DynamicForm/unchecked.gif"CheckboxItem
instance, for chaining setter callssetPrintUncheckedImage(java.lang.String)
,
SCImgURL
,
Appearance overview and related methods
public java.lang.String getUncheckedImage()
The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting
this property to a SCSpriteConfig
formatted string. Alternatively developers can omit
this property and instead use CSS directly in the booleanBaseStyle
property to provide an
"unchecked" appearance.
getPrintUncheckedImage()
,
SCImgURL
,
Appearance overview and related methods
public CheckboxItem setUnsetDescription(java.lang.String unsetDescription)
FormItem.showOldValueInHover
is enabled and a value represents the unset state.
Note : This is an advanced setting
unsetDescription
- New unsetDescription value. Default value is "unset"CheckboxItem
instance, for chaining setter callsHTMLString
public java.lang.String getUnsetDescription()
FormItem.showOldValueInHover
is enabled and a value represents the unset state.HTMLString
public CheckboxItem setUnsetImage(java.lang.String unsetImage)
showUnsetImage
is false or allowEmptyValue
is false the uncheckedImage
will be used for null values
rather than this image. The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting this property to a SCSpriteConfig
formatted string. Alternatively developers can omit this property and instead
use CSS directly in the booleanBaseStyle
property to provide an "unset" appearance.
unsetImage
- New unsetImage value. Default value is "[SKIN]/DynamicForm/unsetcheck.gif"CheckboxItem
instance, for chaining setter callsSCImgURL
,
Appearance overview and related methods
public java.lang.String getUnsetImage()
showUnsetImage
is false or allowEmptyValue
is false the uncheckedImage
will be used for null values
rather than this image. The special value "blank" means that no image will be shown.
Spriting
can be used for this image, by setting this property to a SCSpriteConfig
formatted string. Alternatively developers can omit this property and instead
use CSS directly in the booleanBaseStyle
property to provide an "unset" appearance.
SCImgURL
,
Appearance overview and related methods
public CheckboxItem setWidth(int width)
label
. Note that if showLabel
is false, this property will have no effect
- the item will render at the size required to contain the icon.setWidth
in class FormItem
width
- New width value. Default value is 150CheckboxItem
instance, for chaining setter callsFormItem.setLinearWidth(int)
,
FormItem.setHeight(int)
,
DynamicForm.setItemLayout(com.smartgwt.client.types.FormLayoutType)
,
Form Layout
,
Spanning Examplepublic int getWidth()
label
. Note that if showLabel
is false, this property will have no effect
- the item will render at the size required to contain the icon.getWidth
in class FormItem
FormItem.getLinearWidth()
,
FormItem.getHeight()
,
DynamicForm.getItemLayout()
,
Form Layout
,
Spanning Examplepublic boolean pendingStatusChanged(DynamicForm form, FormItem item, boolean pendingStatus, java.lang.Object newValue, java.lang.Object value)
showPending
is
enabled and this checkbox item should either clear or show its pending visual state. The default behavior is that
the cellStyle
and checkbox label style are updated
to include/exclude the "Pending" suffix. Returning false
will cancel this default behavior.
form
- the managing DynamicForm
instance.item
- the form item itself (also available as "this").pendingStatus
- true
if the item should show its pending visual state; false
otherwise.newValue
- the current form item value.value
- the value that would be restored by a call to DynamicForm.resetValues()
.false
to cancel the default behavior.public static void setDefaultProperties(CheckboxItem checkboxItemProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
checkboxItemProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public void setShowUnsetImage(java.lang.Boolean showUnsetImage)
unsetImage
for null values, or false to use the uncheckedImage
for both null and explicitly unchecked values. If this attribute is not set, the unsetImage
for null values if allowEmptyValue
is true for this item, otherwise the unchecked image will be used.
showUnsetImage
- showUnsetImage Default value is IRApublic java.lang.Boolean getValueAsBoolean()