com.smartgwt.client.widgets
Class Label

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.StatefulCanvas
                      extended by com.smartgwt.client.widgets.Button
                          extended by com.smartgwt.client.widgets.Label
All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.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, HasTitleHoverHandlers, 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
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, nativeObject, scClassName
 
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
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.
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 accommodate 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.
 com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
           
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 receives 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.
 java.lang.String getStyleName()
          Set the CSS class for this widget.
 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 accommodate the title.
 void setContents(java.lang.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(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.
 com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.LabelLogicalStructure s)
           
 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 receives 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 setStyleName(java.lang.String styleName)
          Set the CSS class for this widget.
 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, addTitleHoverHandler, addToRadioGroup, deselect, getActionType, getBaseStyle, getHiliteAccessKey, getIconStyle, getRadioGroup, getSelected, getShowClippedTitleOnHover, getShowDisabled, getShowDown, getShowFocused, getShowRollOver, getState, getTitle, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setBaseStyle, setDefaultProperties, setHiliteAccessKey, setIconStyle, setLogicalStructure, setRadioGroup, setSelected, setShowClippedTitleOnHover, setShowDisabled, setShowDown, setShowFocused, setShowRollOver, setState, setTitle, setTitleHoverFormatter, titleClipped, titleHoverHTML
 
Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas
getIgnoreRTL, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getShowRTLIcon, getStateSuffix, setDefaultProperties, setIgnoreRTL, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas, setShowRTLIcon, setTitleStyle
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, 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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentCanvas, getParentElement, 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, getShrinkElementOnHide, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, 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, 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, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setID, setJavaScriptObject, 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, fireEvent, 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(com.google.gwt.core.client.JavaScriptObject jsObj)

Label

public Label(java.lang.String contents)
Method Detail

getOrCreateRef

public static Label getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:
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.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:
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.
See Also:
AutoChildUsage

create

protected com.google.gwt.core.client.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 - 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(java.lang.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 - Default value is null
See Also:
Sizing overview and related methods

getAutoFit

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 - Default value is false
See Also:
setContents(java.lang.String), com.smartgwt.client.widgets.Canvas#setDynamicContentsVars

getDynamicContents

public java.lang.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(java.lang.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 java.lang.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(java.lang.String iconAlign)
                  throws java.lang.IllegalStateException
If this button is showing an icon should it be right or left aligned?

Overrides:
setIconAlign in class Button
Parameters:
iconAlign - Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getIconAlign

public java.lang.String getIconAlign()
If this button is showing an icon should it be right or left aligned?

Overrides:
getIconAlign in class Button
Returns:
String
See Also:
ButtonIcon overview and related methods

setIconHeight

public void setIconHeight(java.lang.Integer iconHeight)
                   throws java.lang.IllegalStateException
Height in pixels of the icon image.

If unset, defaults to iconSize

Overrides:
setIconHeight in class Button
Parameters:
iconHeight - Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getIconHeight

public java.lang.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(java.lang.String iconOrientation)
                        throws java.lang.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.. Default value is "left"
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getIconOrientation

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

Overrides:
getIconOrientation in class Button
Returns:
String
See Also:
ButtonIcon overview and related methods

setIconSize

public void setIconSize(int iconSize)
                 throws java.lang.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 - Default value is 16
Throws:
java.lang.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 java.lang.IllegalStateException
Pixels between icon and title text.

Parameters:
iconSpacing - Default value is 6
Throws:
java.lang.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(java.lang.Integer iconWidth)
                  throws java.lang.IllegalStateException
Width in pixels of the icon image.

If unset, defaults to iconSize

Overrides:
setIconWidth in class Button
Parameters:
iconWidth - Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getIconWidth

public java.lang.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(java.lang.Boolean showDisabledIcon)
                         throws java.lang.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 - Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getShowDisabledIcon

public java.lang.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(java.lang.Boolean showDownIcon)
                     throws java.lang.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 - Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getShowDownIcon

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

Overrides:
getShowDownIcon in class Button
Returns:
Boolean
See Also:
ButtonIcon overview and related methods

setShowFocusedIcon

public void setShowFocusedIcon(java.lang.Boolean showFocusedIcon)
                        throws java.lang.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 - Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getShowFocusedIcon

public java.lang.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(java.lang.Boolean showRollOverIcon)
                         throws java.lang.IllegalStateException
If using an icon for this button, whether to switch the icon image on mouse rollover.

Overrides:
setShowRollOverIcon in class Button
Parameters:
showRollOverIcon - Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getShowRollOverIcon

public java.lang.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(java.lang.Boolean showSelectedIcon)
                         throws java.lang.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 - Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created
See Also:
ButtonIcon overview and related methods

getShowSelectedIcon

public java.lang.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(java.lang.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 java.lang.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 - 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(java.lang.Boolean wrap)
If false, the label text will not be wrapped to the next line.

Overrides:
setWrap in class Button
Parameters:
wrap - Default value is true
See Also:
Sizing overview and related methods

getWrap

public java.lang.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 existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. 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 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.

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