|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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.CheckboxItem
public class CheckboxItem
Checkbox form item, implemented with customizable checkbox images
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
CheckboxItem()
|
|
CheckboxItem(JavaScriptObject jsObj)
|
|
CheckboxItem(java.lang.String name)
|
|
CheckboxItem(java.lang.String name,
java.lang.String title)
|
Method Summary | |
---|---|
java.lang.Boolean |
getAllowEmptyValue()
By default checkboxes allow the user to toggle between true and false values only. |
java.lang.String |
getCheckedImage()
URL for the image to display when this checkbox is selected, or checked. |
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 overview ). |
static CheckboxItem |
getOrCreateRef(JavaScriptObject jsObj)
|
java.lang.String |
getPartialSelectedImage()
URL for the image to display when this checkbox is partially selected |
java.lang.Boolean |
getShowLabel()
Should we show the label text next to the checkbox item. |
java.lang.Boolean |
getShowTitle()
CheckboxItem has special behavior for titles, see labelAsTitle . |
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 |
getUncheckedImage()
URL for the image to display when this checkbox is not selected, or unchecked |
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 |
void |
setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
By default checkboxes allow the user to toggle between true and false values only. |
void |
setCheckedImage(java.lang.String checkedImage)
URL for the image to display when this checkbox is selected, or checked. |
void |
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 overview ). |
void |
setPartialSelectedImage(java.lang.String partialSelectedImage)
URL for the image to display when this checkbox is partially selected |
void |
setShowLabel(java.lang.Boolean showLabel)
Should we show the label text next to the checkbox item. |
void |
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. |
void |
setTextBoxStyle(java.lang.String textBoxStyle)
Base CSS class for this item's title text |
void |
setTitleStyle(java.lang.String titleStyle)
Base CSS class for this item's title cell. |
void |
setUncheckedImage(java.lang.String uncheckedImage)
URL for the image to display when this checkbox is not selected, or unchecked |
void |
setUnsetImage(java.lang.String unsetImage)
URL for the image to display when this checkbox is unset. |
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 |
---|
public CheckboxItem()
public CheckboxItem(JavaScriptObject jsObj)
public CheckboxItem(java.lang.String name)
public CheckboxItem(java.lang.String name, java.lang.String title)
Method Detail |
---|
public static CheckboxItem getOrCreateRef(JavaScriptObject jsObj)
public void setAllowEmptyValue(java.lang.Boolean allowEmptyValue)
true
, false
and unset.
allowEmptyValue
- allowEmptyValue Default value is falsepublic java.lang.Boolean getAllowEmptyValue()
true
, false
and unset.
public void setCheckedImage(java.lang.String checkedImage)
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
".gif"
extension
checkedImage
- checkedImage Default value is "[SKIN]/DynamicForm/checked.gif"Appearance overview and related methods
public java.lang.String getCheckedImage()
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
".gif"
extension
Appearance overview and related methods
public void setLabelAsTitle(java.lang.Boolean labelAsTitle)
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see form layout overview
). However, the title cell is left blank by default, and the
title specified by 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
- labelAsTitle Default value is nullpublic java.lang.Boolean getLabelAsTitle()
showTitle
:true,
and so takes up two cells with the default TitleOrientation
of "left" (see form layout overview
). However, the title cell is left blank by default, and the
title specified by 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 void setPartialSelectedImage(java.lang.String partialSelectedImage)
partialSelectedImage
- partialSelectedImage Default value is "[SKIN]/DynamicForm/partialcheck.gif"Appearance overview and related methods
public java.lang.String getPartialSelectedImage()
Appearance overview and related methods
public void setShowLabel(java.lang.Boolean showLabel)
showLabel
- showLabel Default value is truepublic java.lang.Boolean getShowLabel()
public void setShowTitle(java.lang.Boolean showTitle)
labelAsTitle
.
setShowTitle
in class FormItem
showTitle
- showTitle Default value is truepublic java.lang.Boolean getShowTitle()
labelAsTitle
.
getShowTitle
in class FormItem
public void setTextBoxStyle(java.lang.String textBoxStyle)
setTextBoxStyle
in class FormItem
textBoxStyle
- textBoxStyle Default value is "labelAnchor"Appearance overview and related methods
public java.lang.String getTextBoxStyle()
getTextBoxStyle
in class FormItem
Appearance overview and related methods
public void 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
- titleStyle Default value is nullAppearance 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
Appearance overview and related methods
public void setUncheckedImage(java.lang.String uncheckedImage)
uncheckedImage
- uncheckedImage Default value is "[SKIN]/DynamicForm/unchecked.gif"Appearance overview and related methods
public java.lang.String getUncheckedImage()
Appearance overview and related methods
public void setUnsetImage(java.lang.String unsetImage)
showUnsetImage
is false or allowEmptyValue
is false the uncheckedImage
will be used for null values
rather than this image.
unsetImage
- unsetImage Default value is "[SKIN]/DynamicForm/unsetcheck.gif"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.
Appearance overview and related methods
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()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |