com.smartgwt.client.widgets
Class Label

java.lang.Object
  com.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

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasIconClickHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

Direct Known Subclasses:

SectionHeader, ViewLoader

public class Label
extends Button

Labels display a small amount of alignable text 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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

config, configOnly, id, isElementSet, nativeObject, scClassName

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Label()

Label(JavaScriptObject jsObj)

Label(String contents)

Method Summary

protected JavaScriptObject	create()
Alignment	getAlign() Horizontal alignment of label text.
Boolean	getAutoFit() If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
String	getContents() The contents of a canvas or label widget.
Boolean	getDynamicContents() Dynamic contents allows the contents string to be treated as a simple, but powerful template.
String	getIcon() Optional icon to be shown with the button title text.
String	getIconAlign() If this button is showing an icon should it be right or left aligned?
Integer	getIconHeight() Height in pixels of the icon image.
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.
Integer	getIconWidth() Width in pixels of the icon image.
com.smartgwt.logicalstructure.core.LogicalStructureObject	getLogicalStructure()
static Label	getOrCreateRef(JavaScriptObject jsObj)
Boolean	getShowDisabledIcon() If using an icon for this button, whether to switch the icon image if the button becomes disabled.
Boolean	getShowDownIcon() If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
Boolean	getShowFocusedIcon() If using an icon for this button, whether to switch the icon image when the button receives focus.
Boolean	getShowRollOverIcon() If using an icon for this button, whether to switch the icon image on mouse rollover.
Boolean	getShowSelectedIcon() If using an icon for this button, whether to switch the icon image when the button becomes selected.
String	getStyleName() Set the CSS class for this widget.
VerticalAlignment	getValign() Vertical alignment of label text.
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(Boolean autoFit) If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
void	setContents(String contents) The contents of a canvas or label widget.
static void	setDefaultProperties(Label labelProperties) Class level method to set the default properties of this class.
void	setDynamicContents(Boolean dynamicContents) Dynamic contents allows the contents string to be treated as a simple, but powerful template.
void	setIcon(String icon) Optional icon to be shown with the button title text.
void	setIconAlign(String iconAlign) If this button is showing an icon should it be right or left aligned?
void	setIconHeight(Integer iconHeight) Height in pixels of the icon image.
void	setIconOrientation(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(Integer iconWidth) Width in pixels of the icon image.
void	setJavaScriptObject(JavaScriptObject jsObj)
com.smartgwt.logicalstructure.core.LogicalStructureObject	setLogicalStructure(com.smartgwt.logicalstructure.widgets.LabelLogicalStructure s)
void	setShowDisabledIcon(Boolean showDisabledIcon) If using an icon for this button, whether to switch the icon image if the button becomes disabled.
void	setShowDownIcon(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(Boolean showFocusedIcon) If using an icon for this button, whether to switch the icon image when the button receives focus.
void	setShowRollOverIcon(Boolean showRollOverIcon) If using an icon for this button, whether to switch the icon image on mouse rollover.
void	setShowSelectedIcon(Boolean showSelectedIcon) If using an icon for this button, whether to switch the icon image when the button becomes selected.
void	setStyleName(String styleName) Set the CSS class for this widget.
void	setValign(VerticalAlignment valign) Vertical alignment of label text.
void	setWrap(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, setDefaultProperties, setDisabled, setHiliteAccessKey, setLogicalStructure, setRadioGroup, setSelected, setShowDisabled, setShowDown, setShowFocused, setShowRollOver, setState, setTitle, setVAlign

Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas

getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getStateSuffix, setDefaultProperties, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas, setTitleStyle

Methods inherited from class com.smartgwt.client.widgets.Canvas

addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, deparent, depeer, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAttribute, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getParentElements, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, initNativeObject, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, 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

Label

public Label()

Label

public Label(JavaScriptObject jsObj)

Label

public Label(String contents)

Method Detail

getOrCreateRef

public static Label getOrCreateRef(JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class Button

create

protected JavaScriptObject create()

Overrides:

create in class Button

setAlign

public void setAlign(Alignment align)

Horizontal alignment of label text. See Alignment type for details.

Overrides:

setAlign in class Button

Parameters:

align - align Default value is Canvas.LEFT

See Also:

Positioning overview and related methods

getAlign

public Alignment getAlign()

Horizontal alignment of label text. See Alignment type for details.

Overrides:

getAlign in class Button

Returns:

Alignment

See Also:

Positioning overview and related methods

setAutoFit

public void setAutoFit(Boolean autoFit)

If true, ignore the specified size of this widget and always size just large enough to accommodate the title. If 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"

Overrides:

setAutoFit in class Button

Parameters:

autoFit - autoFit Default value is null

See Also:

Sizing overview and related methods

getAutoFit

public Boolean getAutoFit()

If true, ignore the specified size of this widget and always size just large enough to accommodate the title. If 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"

Overrides:

getAutoFit in class Button

Returns:

Boolean

See Also:

Sizing overview and related methods

setContents

public void setContents(String contents)

The contents of a canvas or label widget. Any HTML string is acceptable.

If this method is called after the component has been drawn/initialized: Changes the contents of a widget to newContents, an HTML string.

When dynamicContents is set, setContents() can also be called with no arguments to cause contents to be re-evaluated.

Overrides:

setContents in class Canvas

Parameters:

contents - an HTML string to be set as the contents of this widget. See HTMLString. Default value is " "

See Also:

setDynamicContents(java.lang.Boolean)

getContents

public String getContents()

The contents of a canvas or label widget. Any HTML string is acceptable.

Overrides:

getContents in class Canvas

Returns:

. See HTMLString

See Also:

getDynamicContents()

setDynamicContents

public void setDynamicContents(Boolean dynamicContents)

Dynamic contents allows the contents string to be treated as a simple, but powerful template. When this attribute is set to true, expressions of the form \${arbitrary JS here} are replaced by the result of the evaluation of the JS code inside the curly brackets. This evaluation happens at draw time. If you want to trigger a re-evaluation of the expressions in the contents string you can call markForRedraw() on the canvas.

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 evaluation 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

Overrides:

setDynamicContents in class Canvas

Parameters:

dynamicContents - dynamicContents Default value is false

See Also:

setContents(java.lang.String), com.smartgwt.client.widgets.Canvas#setDynamicContentsVars

getDynamicContents

public Boolean getDynamicContents()

Dynamic contents allows the contents string to be treated as a simple, but powerful template. When this attribute is set to true, expressions of the form \${arbitrary JS here} are replaced by the result of the evaluation of the JS code inside the curly brackets. This evaluation happens at draw time. If you want to trigger a re-evaluation of the expressions in the contents string you can call markForRedraw() on the canvas.

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 evaluation 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.

Overrides:

getDynamicContents in class Canvas

Returns:

Boolean

See Also:

getContents(), com.smartgwt.client.widgets.Canvas#getDynamicContentsVars

setIcon

public void setIcon(String icon)

Optional icon to be shown with the button title text.

Specify as the partial URL to an image, relative to the imgDir of this component.

If this method is called after the component has been drawn/initialized: Change the icon being shown next to the title text.

Overrides:

setIcon in class Button

Parameters:

icon - URL of new icon. See SCImgURL. Default value is null

See Also:

ButtonIcon overview and related methods

getIcon

public String getIcon()

Optional icon to be shown with the button title text.

Specify as the partial URL to an image, relative to the imgDir of this component.

Overrides:

getIcon in class Button

Returns:

. See SCImgURL

See Also:

ButtonIcon overview and related methods

setIconAlign

public void setIconAlign(String iconAlign)
                  throws IllegalStateException

If this button is showing an icon should it be right or left aligned?

Overrides:

setIconAlign in class Button

Parameters:

iconAlign - . See String. Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconAlign

public String getIconAlign()

If this button is showing an icon should it be right or left aligned?

Overrides:

getIconAlign in class Button

Returns:

. See String

See Also:

ButtonIcon overview and related methods

setIconHeight

public void setIconHeight(Integer iconHeight)
                   throws IllegalStateException

Height in pixels of the icon image.

If unset, defaults to iconSize

Overrides:

setIconHeight in class Button

Parameters:

iconHeight - iconHeight Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconHeight

public Integer getIconHeight()

Height in pixels of the icon image.

If unset, defaults to iconSize

Overrides:

getIconHeight in class Button

Returns:

Integer

See Also:

ButtonIcon overview and related methods

setIconOrientation

public void setIconOrientation(String iconOrientation)
                        throws IllegalStateException

If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right".

If this method is called after the component has been drawn/initialized: Changes the orientation of the icon relative to the text of the button.

Overrides:

setIconOrientation in class Button

Parameters:

iconOrientation - The new orientation of the icon relative to the text of the button.. See String. Default value is "left"

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconOrientation

public 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".

Overrides:

getIconOrientation in class Button

Returns:

. See String

See Also:

ButtonIcon overview and related methods

setIconSize

public void setIconSize(int iconSize)
                 throws IllegalStateException

Size in pixels of the icon image.

The iconWidth and iconHeight properties can be used to configure width and height separately.

Overrides:

setIconSize in class Button

Parameters:

iconSize - iconSize Default value is 16

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconSize

public int getIconSize()

Size in pixels of the icon image.

The iconWidth and iconHeight properties can be used to configure width and height separately.

Overrides:

getIconSize in class Button

Returns:

int

See Also:

ButtonIcon overview and related methods

setIconSpacing

public void setIconSpacing(int iconSpacing)
                    throws IllegalStateException

Pixels between icon and title text.

Parameters:

iconSpacing - iconSpacing Default value is 6

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconSpacing

public int getIconSpacing()

Pixels between icon and title text.

Returns:

int

See Also:

ButtonIcon overview and related methods

setIconWidth

public void setIconWidth(Integer iconWidth)
                  throws IllegalStateException

Width in pixels of the icon image.

If unset, defaults to iconSize

Overrides:

setIconWidth in class Button

Parameters:

iconWidth - iconWidth Default value is null

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getIconWidth

public Integer getIconWidth()

Width in pixels of the icon image.

If unset, defaults to iconSize

Overrides:

getIconWidth in class Button

Returns:

Integer

See Also:

ButtonIcon overview and related methods

setShowDisabledIcon

public void setShowDisabledIcon(Boolean showDisabledIcon)
                         throws IllegalStateException

If using an icon for this button, whether to switch the icon image if the button becomes disabled.

Overrides:

setShowDisabledIcon in class Button

Parameters:

showDisabledIcon - showDisabledIcon Default value is true

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowDisabledIcon

public Boolean getShowDisabledIcon()

If using an icon for this button, whether to switch the icon image if the button becomes disabled.

Overrides:

getShowDisabledIcon in class Button

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowDownIcon

public void setShowDownIcon(Boolean showDownIcon)
                     throws IllegalStateException

If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.

Overrides:

setShowDownIcon in class Button

Parameters:

showDownIcon - showDownIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowDownIcon

public Boolean getShowDownIcon()

If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.

Overrides:

getShowDownIcon in class Button

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowFocusedIcon

public void setShowFocusedIcon(Boolean showFocusedIcon)
                        throws IllegalStateException

If using an icon for this button, whether to switch the icon image when the button receives focus.

If showFocusedAsOver is true, the "Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon will be displayed

Overrides:

setShowFocusedIcon in class Button

Parameters:

showFocusedIcon - showFocusedIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowFocusedIcon

public Boolean getShowFocusedIcon()

If using an icon for this button, whether to switch the icon image when the button receives focus.

If showFocusedAsOver is true, the "Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon will be displayed

Overrides:

getShowFocusedIcon in class Button

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowRollOverIcon

public void setShowRollOverIcon(Boolean showRollOverIcon)
                         throws IllegalStateException

If using an icon for this button, whether to switch the icon image on mouse rollover.

Overrides:

setShowRollOverIcon in class Button

Parameters:

showRollOverIcon - showRollOverIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowRollOverIcon

public Boolean getShowRollOverIcon()

If using an icon for this button, whether to switch the icon image on mouse rollover.

Overrides:

getShowRollOverIcon in class Button

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setShowSelectedIcon

public void setShowSelectedIcon(Boolean showSelectedIcon)
                         throws IllegalStateException

If using an icon for this button, whether to switch the icon image when the button becomes selected.

Overrides:

setShowSelectedIcon in class Button

Parameters:

showSelectedIcon - showSelectedIcon Default value is false

Throws:

IllegalStateException - this property cannot be changed after the component has been created

See Also:

ButtonIcon overview and related methods

getShowSelectedIcon

public Boolean getShowSelectedIcon()

If using an icon for this button, whether to switch the icon image when the button becomes selected.

Overrides:

getShowSelectedIcon in class Button

Returns:

Boolean

See Also:

ButtonIcon overview and related methods

setStyleName

public void setStyleName(String styleName)

Set the CSS class for this widget. For a Label, this is equivalent to setting baseStyle.

If this method is called after the component has been drawn/initialized: Dynamically change the CSS class for this widget. For a Label, this is equivalent to setBaseStyle.

Overrides:

setStyleName in class Canvas

Parameters:

styleName - new CSS style name. See CSSStyleName. Default value is "normal"

See Also:

Appearance overview and related methods, CSS styles Example

getStyleName

public String getStyleName()

Set the CSS class for this widget. For a Label, this is equivalent to setting baseStyle.

Overrides:

getStyleName in class Canvas

Returns:

. See CSSStyleName

See Also:

Appearance overview and related methods, CSS styles Example

setValign

public void setValign(VerticalAlignment valign)

Vertical alignment of label text. See VerticalAlignment type for details.

Overrides:

setValign in class Button

Parameters:

valign - valign Default value is Canvas.CENTER

See Also:

Positioning overview and related methods

getValign

public VerticalAlignment getValign()

Vertical alignment of label text. See VerticalAlignment type for details.

Overrides:

getValign in class Button

Returns:

VerticalAlignment

See Also:

Positioning overview and related methods

setWrap

public void setWrap(Boolean wrap)

If false, the label text will not be wrapped to the next line.

Overrides:

setWrap in class Button

Parameters:

wrap - wrap Default value is true

See Also:

Sizing overview and related methods

getWrap

public Boolean getWrap()

If false, the label text will not be wrapped to the next line.

Overrides:

getWrap in class Button

Returns:

Boolean

See Also:

Sizing overview and related methods

setDefaultProperties

public static void setDefaultProperties(Label labelProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Note: This method is intended for setting default attributes only and will effect 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.

Parameters:

labelProperties - properties that should be used as new defaults when instances of this class are created

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.LabelLogicalStructure s)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()

Specified by:

getLogicalStructure in interface LogicalStructure

Overrides:

getLogicalStructure in class Button