|
|||||||||
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.widgets.form.fields.FormItemIcon
public class FormItemIcon
Form item icon descriptor objects used by Form Items to specify the appearance and behavior of icons displayed after the item in the page flow.
Field Summary |
---|
Fields inherited from class com.smartgwt.client.core.JsObject |
---|
jsObj |
Constructor Summary | |
---|---|
FormItemIcon()
|
|
FormItemIcon(com.google.gwt.core.client.JavaScriptObject jsObj)
|
Method Summary | |
---|---|
void |
click(DynamicForm form,
FormItem item,
FormItemIcon icon)
StringMethod action to fire when this icon is clicked If unset the form item's iconClick method will be fired instead (if
specified).
|
java.lang.Integer |
getHeight()
If set, this property determines the height of this icon in px. If unset the form item's iconHeight property will be used instead. |
java.lang.Boolean |
getNeverDisable()
If icon.neverDisable is true, when this form item is disabled, the
icon will remain enabled. |
static FormItemIcon |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
java.lang.String |
getPrompt()
If set, this property will be displayed as a prompt (and tooltip text) for this form item icon. |
java.lang.Boolean |
getShowFocused()
Should this icon's image switch to the appropriate "focused" source when the user puts focus on the form item or icon? |
java.lang.Boolean |
getShowFocusedWithItem()
If this icon will be updated to show focus (see showFocused ,
showFocusedIcons ), this property governs whether the focused state should
be shown when the item as a whole recieves focus or just if the icon recieves focus.
If this property is unset, default behavior is to show focused state when the item
recieves focus. |
java.lang.Boolean |
getShowOver()
Should this icon's image switch to the appropriate "over" source when the user rolls over or focuses on the icon? |
java.lang.String |
getSrc()
If set, this property determines this icon's image source. If unset the form item's defaultIconSrc property will be used
instead.As with defaultIconSrc this URL will be modified by adding
"_Over" or "_Disabled" if appropriate to show the icons over or disabled state. |
java.lang.Integer |
getWidth()
If set, this property determines the width of this icon in px. If unset the form item's iconWidth property will be used instead. |
void |
keyPress(java.lang.String keyName,
char character,
DynamicForm form,
FormItem item,
FormItemIcon icon)
StringMethod action to fire when this icon has focus and recieves a keypress event. If unset the form item's iconKeyPress method will be fired instead
(if specified).
|
void |
setHeight(java.lang.Integer height)
If set, this property determines the height of this icon in px. If unset the form item's iconHeight property will be used instead. |
void |
setNeverDisable(java.lang.Boolean neverDisable)
If icon.neverDisable is true, when this form item is disabled, the
icon will remain enabled. |
void |
setPrompt(java.lang.String prompt)
If set, this property will be displayed as a prompt (and tooltip text) for this form item icon. |
void |
setShowFocused(java.lang.Boolean showFocused)
Should this icon's image switch to the appropriate "focused" source when the user puts focus on the form item or icon? |
void |
setShowFocusedWithItem(java.lang.Boolean showFocusedWithItem)
If this icon will be updated to show focus (see showFocused ,
showFocusedIcons ), this property governs whether the focused state should
be shown when the item as a whole recieves focus or just if the icon recieves focus.
If this property is unset, default behavior is to show focused state when the item
recieves focus. |
void |
setShowOver(java.lang.Boolean showOver)
Should this icon's image switch to the appropriate "over" source when the user rolls over or focuses on the icon? |
void |
setSrc(java.lang.String src)
If set, this property determines this icon's image source. If unset the form item's defaultIconSrc property will be used
instead.As with defaultIconSrc this URL will be modified by adding
"_Over" or "_Disabled" if appropriate to show the icons over or disabled state. |
void |
setWidth(java.lang.Integer width)
If set, this property determines the width of this icon in px. If unset the form item's iconWidth property will be used instead. |
Methods inherited from class com.smartgwt.client.core.JsObject |
---|
isCreated, setJsObj |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FormItemIcon()
public FormItemIcon(com.google.gwt.core.client.JavaScriptObject jsObj)
Method Detail |
---|
public static FormItemIcon getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setSrc(java.lang.String src)
defaultIconSrc
property will be used
instead.defaultIconSrc
this URL will be modified by adding
"_Over" or "_Disabled" if appropriate to show the icons over or disabled state.
src
- src Default value is nullpublic java.lang.String getSrc()
defaultIconSrc
property will be used
instead.defaultIconSrc
this URL will be modified by adding
"_Over" or "_Disabled" if appropriate to show the icons over or disabled state.
public void setShowOver(java.lang.Boolean showOver)
Note : This is an advanced setting
showOver
- showOver Default value is nullpublic java.lang.Boolean getShowOver()
public void setShowFocused(java.lang.Boolean showFocused)
Note : This is an advanced setting
showFocused
- showFocused Default value is nullpublic java.lang.Boolean getShowFocused()
public void setShowFocusedWithItem(java.lang.Boolean showFocusedWithItem)
showFocused
,
showFocusedIcons
), this property governs whether the focused state should
be shown when the item as a whole recieves focus or just if the icon recieves focus.
If this property is unset, default behavior is to show focused state when the item
recieves focus.
Note : This is an advanced setting
showFocusedWithItem
- showFocusedWithItem Default value is nullpublic java.lang.Boolean getShowFocusedWithItem()
showFocused
,
showFocusedIcons
), this property governs whether the focused state should
be shown when the item as a whole recieves focus or just if the icon recieves focus.
If this property is unset, default behavior is to show focused state when the item
recieves focus.
public void setNeverDisable(java.lang.Boolean neverDisable)
icon.neverDisable
is true, when this form item is disabled, the
icon will remain enabled.
Note that disabling the entire form will disable all items, together with their
icons including those marked as neverDisable - this property only has an effect
if the form is enabled and a specific item is disabled within it.
Note : This is an advanced setting
neverDisable
- neverDisable Default value is nullpublic java.lang.Boolean getNeverDisable()
icon.neverDisable
is true, when this form item is disabled, the
icon will remain enabled.
Note that disabling the entire form will disable all items, together with their
icons including those marked as neverDisable - this property only has an effect
if the form is enabled and a specific item is disabled within it.
public void setWidth(java.lang.Integer width)
iconWidth
property will be used instead.
width
- width Default value is nullpublic java.lang.Integer getWidth()
iconWidth
property will be used instead.
public void setHeight(java.lang.Integer height)
iconHeight
property will be used instead.
height
- height Default value is nullpublic java.lang.Integer getHeight()
iconHeight
property will be used instead.
public void setPrompt(java.lang.String prompt)
If unset the form item's iconPrompt
property will be used instead.
Note : This is an advanced setting
prompt
- prompt Default value is nullpublic java.lang.String getPrompt()
If unset the form item's iconPrompt
property will be used instead.
public void click(DynamicForm form, FormItem item, FormItemIcon icon)
iconClick
method will be fired instead (if
specified).
form
- The Dynamic Form to which this icon's item belongs.item
- The Form Item containing this iconicon
- A pointer to the form item icon clickedpublic void keyPress(java.lang.String keyName, char character, DynamicForm form, FormItem item, FormItemIcon icon)
iconKeyPress
method will be fired instead
(if specified).
keyName
- Name of the key pressedcharacter
- character produced by the keypressform
- The Dynamic Form to which this icon's item belongs.item
- The Form Item containing this iconicon
- A pointer to the form item icon
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |