|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.StatefulCanvas
com.smartgwt.client.widgets.Button
com.smartgwt.client.widgets.Label
public class Label
Labels display a small amount of align
contents
with optional icon
and autoFit
.
For a general-purpose container for HTML content, use HTMLFlow
or HTMLPane
instead.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject |
---|
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled |
Field Summary |
---|
Fields inherited from class com.smartgwt.client.widgets.BaseWidget |
---|
config, configOnly, id, isElementSet |
Fields inherited from class com.google.gwt.user.client.ui.UIObject |
---|
DEBUG_ID_PREFIX |
Constructor Summary | |
---|---|
Label()
|
|
Label(com.google.gwt.core.client.JavaScriptObject jsObj)
|
|
Label(java.lang.String contents)
|
Method Summary | |
---|---|
protected com.google.gwt.core.client.JavaScriptObject |
create()
|
Alignment |
getAlign()
Horizontal alignment of label text. |
java.lang.Boolean |
getAutoFit()
If true, ignore the specified size of this widget and always size just large enough to accomodate the title. |
java.lang.String |
getContents()
The contents of a canvas or label widget. |
java.lang.Boolean |
getDynamicContents()
Dynamic contents allows the contents string to be treated as a simple, but powerful template. |
java.lang.String |
getIcon()
Optional icon to be shown with the button title text. |
java.lang.String |
getIconAlign()
If this button is showing an icon should it be right or left aligned? |
java.lang.Integer |
getIconHeight()
Height in pixels of the icon image. |
java.lang.String |
getIconOrientation()
If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right" . |
int |
getIconSize()
Size in pixels of the icon image. |
int |
getIconSpacing()
Pixels between icon and title text. |
java.lang.Integer |
getIconWidth()
Width in pixels of the icon image. |
static Label |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
|
java.lang.Boolean |
getShowDisabledIcon()
If using an icon for this button, whether to switch the icon image if the button becomes disabled. |
java.lang.Boolean |
getShowDownIcon()
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button. |
java.lang.Boolean |
getShowFocusedIcon()
If using an icon for this button, whether to switch the icon image when the button recieves focus. |
java.lang.Boolean |
getShowRollOverIcon()
If using an icon for this button, whether to switch the icon image on mouse rollover. |
java.lang.Boolean |
getShowSelectedIcon()
If using an icon for this button, whether to switch the icon image when the button becomes selected. |
VerticalAlignment |
getValign()
Vertical alignment of label text. |
java.lang.Boolean |
getWrap()
If false, the label text will not be wrapped to the next line. |
void |
setAlign(Alignment align)
Horizontal alignment of label text. |
void |
setAutoFit(java.lang.Boolean autoFit)
If true, ignore the specified size of this widget and always size just large enough to accomodate the title. |
void |
setContents(java.lang.String contents)
The contents of a canvas or label widget. |
void |
setDynamicContents(java.lang.Boolean dynamicContents)
Dynamic contents allows the contents string to be treated as a simple, but powerful template. |
void |
setIcon(java.lang.String icon)
Optional icon to be shown with the button title text. |
void |
setIconAlign(java.lang.String iconAlign)
If this button is showing an icon should it be right or left aligned? |
void |
setIconHeight(java.lang.Integer iconHeight)
Height in pixels of the icon image. |
void |
setIconOrientation(java.lang.String iconOrientation)
If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right" . |
void |
setIconSize(int iconSize)
Size in pixels of the icon image. |
void |
setIconSpacing(int iconSpacing)
Pixels between icon and title text. |
void |
setIconWidth(java.lang.Integer iconWidth)
Width in pixels of the icon image. |
void |
setShowDisabledIcon(java.lang.Boolean showDisabledIcon)
If using an icon for this button, whether to switch the icon image if the button becomes disabled. |
void |
setShowDownIcon(java.lang.Boolean showDownIcon)
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button. |
void |
setShowFocusedIcon(java.lang.Boolean showFocusedIcon)
If using an icon for this button, whether to switch the icon image when the button recieves focus. |
void |
setShowRollOverIcon(java.lang.Boolean showRollOverIcon)
If using an icon for this button, whether to switch the icon image on mouse rollover. |
void |
setShowSelectedIcon(java.lang.Boolean showSelectedIcon)
If using an icon for this button, whether to switch the icon image when the button becomes selected. |
void |
setValign(VerticalAlignment valign)
Vertical alignment of label text. |
void |
setWrap(java.lang.Boolean wrap)
If false, the label text will not be wrapped to the next line. |
Methods inherited from class com.smartgwt.client.widgets.Button |
---|
action, addIconClickHandler, addToRadioGroup, deselect, getActionType, getBaseStyle, getHiliteAccessKey, getRadioGroup, getSelected, getShowDisabled, getShowDown, getShowFocused, getShowRollOver, getState, getTitle, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setBaseStyle, setDisabled, setHiliteAccessKey, setRadioGroup, setSelected, setShowDisabled, setShowDown, setShowFocused, setShowRollOver, setState, setTitle, setVAlign |
Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas |
---|
getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getStateSuffix, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas, setTitleStyle |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent |
Methods inherited from class com.google.gwt.user.client.ui.UIObject |
---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.google.gwt.event.shared.HasHandlers |
---|
fireEvent |
Constructor Detail |
---|
public Label()
public Label(com.google.gwt.core.client.JavaScriptObject jsObj)
public Label(java.lang.String contents)
Method Detail |
---|
public static Label getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
protected com.google.gwt.core.client.JavaScriptObject create()
create
in class Button
public void setContents(java.lang.String contents)
When dynamicContents
is set, setContents()
can
also be called with no arguments to cause contents to be re-evaluated.
setContents
in class Canvas
contents
- an HTML string to be set as the contents of this widget. Default value is " "public java.lang.String getContents()
getContents
in class Canvas
public void setDynamicContents(java.lang.Boolean dynamicContents)
You can use this feature to build some simple custom components. For example, let's say you want to show the value of a Slider in a Canvas somewhere on the screen. You can do this by observing the valueChanged() method on the slider and calling setContents() on your canvas with the new string or you can set the contents of the canvas to something like:
"The slider value is \${sliderInstance.getValue()}."
Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider and call canvas.markForRedraw() in that observation. This approach is cleaner than setContents() when the Canvas is aggregating several values or dynamic expressions. Like so:
Slider.create({ ID: "mySlider" }); Canvas.create({ ID: "myCanvas", dynamicContents: true, contents: "The slider value is \${mySlider.getValue()}." }); myCanvas.observe(mySlider, "valueChanged", "observer.markForRedraw()");You can embed an arbitrary number of dynamic expressions in the contents string. The search and replace is optimized for speed.
If an error occurs during the evaluation of one of the expressions, a warning is logged to the ISC Developer Console and the error string is embedded in place of the expected value in the Canvas.
The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
Inside the evalution contentext, this
points to the canvas instance that
has the dynamicContents string as its contents - in other words the canvas instance on
which the template is declared.
Note : This is an advanced setting
setDynamicContents
in class Canvas
dynamicContents
- dynamicContents Default value is falsepublic java.lang.Boolean getDynamicContents()
You can use this feature to build some simple custom components. For example, let's say you want to show the value of a Slider in a Canvas somewhere on the screen. You can do this by observing the valueChanged() method on the slider and calling setContents() on your canvas with the new string or you can set the contents of the canvas to something like:
"The slider value is \${sliderInstance.getValue()}."
Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider and call canvas.markForRedraw() in that observation. This approach is cleaner than setContents() when the Canvas is aggregating several values or dynamic expressions. Like so:
Slider.create({ ID: "mySlider" }); Canvas.create({ ID: "myCanvas", dynamicContents: true, contents: "The slider value is \${mySlider.getValue()}." }); myCanvas.observe(mySlider, "valueChanged", "observer.markForRedraw()");You can embed an arbitrary number of dynamic expressions in the contents string. The search and replace is optimized for speed.
If an error occurs during the evaluation of one of the expressions, a warning is logged to the ISC Developer Console and the error string is embedded in place of the expected value in the Canvas.
The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
Inside the evalution contentext, this
points to the canvas instance that
has the dynamicContents string as its contents - in other words the canvas instance on
which the template is declared.
getDynamicContents
in class Canvas
public void setAlign(Alignment align)
setAlign
in class Button
align
- align Default value is Canvas.LEFTpublic Alignment getAlign()
getAlign
in class Button
public void setValign(VerticalAlignment valign)
setValign
in class Button
valign
- valign Default value is Canvas.CENTERpublic VerticalAlignment getValign()
getValign
in class Button
public void setWrap(java.lang.Boolean wrap)
setWrap
in class Button
wrap
- wrap Default value is truepublic java.lang.Boolean getWrap()
getWrap
in class Button
public void setAutoFit(java.lang.Boolean autoFit)
setWidth()
is explicitly called on an
autoFit:true button, autoFit will be reset to false
.
Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
setAutoFit
in class Button
autoFit
- autoFit Default value is nullpublic java.lang.Boolean getAutoFit()
setWidth()
is explicitly called on an
autoFit:true button, autoFit will be reset to false
.
Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
getAutoFit
in class Button
public void setIcon(java.lang.String icon)
Specify as the partial URL to an image, relative to the imgDir of this component. Change the icon being shown next to the title text.
setIcon
in class Button
icon
- URL of new icon. Default value is nullpublic java.lang.String getIcon()
Specify as the partial URL to an image, relative to the imgDir of this component.
getIcon
in class Button
public void setIconSize(int iconSize) throws java.lang.IllegalStateException
The iconWidth
and iconHeight
properties can be used to
configure width and height separately.
setIconSize
in class Button
iconSize
- iconSize Default value is 16
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getIconSize()
The iconWidth
and iconHeight
properties can be used to
configure width and height separately.
getIconSize
in class Button
public void setIconWidth(java.lang.Integer iconWidth) throws java.lang.IllegalStateException
If unset, defaults to iconSize
setIconWidth
in class Button
iconWidth
- iconWidth Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getIconWidth()
If unset, defaults to iconSize
getIconWidth
in class Button
public void setIconHeight(java.lang.Integer iconHeight) throws java.lang.IllegalStateException
If unset, defaults to iconSize
setIconHeight
in class Button
iconHeight
- iconHeight Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Integer getIconHeight()
If unset, defaults to iconSize
getIconHeight
in class Button
public void setIconOrientation(java.lang.String iconOrientation) throws java.lang.IllegalStateException
"left"
and "right"
.
Changes the orientation of the icon relative to the text of the button.
setIconOrientation
in class Button
iconOrientation
- The new orientation of the icon relative to the text of the button.. Default value is "left"
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getIconOrientation()
"left"
and "right"
.
getIconOrientation
in class Button
public void setIconAlign(java.lang.String iconAlign) throws java.lang.IllegalStateException
setIconAlign
in class Button
iconAlign
- iconAlign Default value is null
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.String getIconAlign()
getIconAlign
in class Button
public void setIconSpacing(int iconSpacing) throws java.lang.IllegalStateException
iconSpacing
- iconSpacing Default value is 6
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic int getIconSpacing()
public void setShowDisabledIcon(java.lang.Boolean showDisabledIcon) throws java.lang.IllegalStateException
setShowDisabledIcon
in class Button
showDisabledIcon
- showDisabledIcon Default value is true
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDisabledIcon()
getShowDisabledIcon
in class Button
public void setShowRollOverIcon(java.lang.Boolean showRollOverIcon) throws java.lang.IllegalStateException
setShowRollOverIcon
in class Button
showRollOverIcon
- showRollOverIcon Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowRollOverIcon()
getShowRollOverIcon
in class Button
public void setShowFocusedIcon(java.lang.Boolean showFocusedIcon) throws java.lang.IllegalStateException
If showFocusedAsOver
is true, the "Over"
icon will be
displayed when the canvas has focus, otherwise a seperate "Focused"
icon
will be displayed
setShowFocusedIcon
in class Button
showFocusedIcon
- showFocusedIcon Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowFocusedIcon()
If showFocusedAsOver
is true, the "Over"
icon will be
displayed when the canvas has focus, otherwise a seperate "Focused"
icon
will be displayed
getShowFocusedIcon
in class Button
public void setShowDownIcon(java.lang.Boolean showDownIcon) throws java.lang.IllegalStateException
setShowDownIcon
in class Button
showDownIcon
- showDownIcon Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowDownIcon()
getShowDownIcon
in class Button
public void setShowSelectedIcon(java.lang.Boolean showSelectedIcon) throws java.lang.IllegalStateException
setShowSelectedIcon
in class Button
showSelectedIcon
- showSelectedIcon Default value is false
java.lang.IllegalStateException
- this property cannot be changed after the component has been createdpublic java.lang.Boolean getShowSelectedIcon()
getShowSelectedIcon
in class Button
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |