Class Label
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,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,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasTitleHoverHandlers,HasVisibilityChangedHandlers
- Direct Known Subclasses:
SectionHeader,ViewLoader
-
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, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()getAlign()Horizontal alignment of label text.If true, ignore the specified size of this widget and always size just large enough to accommodate the title.The contents of a canvas or label widget.Dynamic contents allows the contents string to be treated as a simple but powerful template.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.Size for this component's vertical dimension.Size for this component's vertical dimension.getIcon()Optional icon to be shown with the button title text.If this button is showing an icon should it be right or left aligned?Height in pixels of the icon image.If this button is showing an icon should it appear to the left or right of the title? valid options are"left"and"right".intSize in pixels of the icon image.intPixels between icon and title text.Width in pixels of the icon image.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.static LabelgetOrCreateRef(JavaScriptObject jsObj) If using an icon for this button, whether to switch the icon image if the button becomes disabled.If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.If using an icon for this button, whether to switch the icon image when the button receives focus.If using an icon for this button, whether to switch the icon image on mouse rollover.If using an icon for this button, whether to switch the icon image when the button becomes selected.Set the CSS class for this widget.Vertical alignment of label text.getWidth()Size for this component's horizontal dimension.Size for this component's horizontal dimension.getWrap()If false, the label text will not be wrapped to the next line.Horizontal alignment of label text.setAutoFit(Boolean autoFit) If true, ignore the specified size of this widget and always size just large enough to accommodate the title.setContents(String contents) The contents of a canvas or label widget.static voidsetDefaultProperties(Label labelProperties) Class level method to set the default properties of this class.setDynamicContents(Boolean dynamicContents) Dynamic contents allows the contents string to be treated as a simple but powerful template.setEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.Size for this component's vertical dimension.voidSize for this component's vertical dimension.Optional icon to be shown with the button title text.setIconAlign(String iconAlign) If this button is showing an icon should it be right or left aligned?setIconHeight(Integer iconHeight) Height in pixels of the icon image.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".setIconSize(int iconSize) Size in pixels of the icon image.setIconSpacing(int iconSpacing) Pixels between icon and title text.setIconWidth(Integer iconWidth) Width in pixels of the icon image.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setShowDisabledIcon(Boolean showDisabledIcon) If using an icon for this button, whether to switch the icon image if the button becomes disabled.setShowDownIcon(Boolean showDownIcon) If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.setShowFocusedIcon(Boolean showFocusedIcon) If using an icon for this button, whether to switch the icon image when the button receives focus.setShowRollOverIcon(Boolean showRollOverIcon) If using an icon for this button, whether to switch the icon image on mouse rollover.setShowSelectedIcon(Boolean showSelectedIcon) If using an icon for this button, whether to switch the icon image when the button becomes selected.voidsetStyleName(String styleName) Set the CSS class for this widget.setValign(VerticalAlignment valign) Vertical alignment of label text.Size for this component's horizontal dimension.voidSize for this component's horizontal dimension.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, assertIsButton, deselect, getActionType, getAdaptWidthShowIconOnly, getBaseStyle, getCanAdaptWidth, getDefiningProperty, getDisabledIconCursor, getHiliteAccessKey, getIconCursor, getIconOnlyBaseStyle, getIconStyle, getOverflow, getRadioGroup, getShowClippedTitleOnHover, getShowDisabled, getShowDown, getShowFocused, getShowRollOver, getState, getTitle, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setAdaptWidthShowIconOnly, setBaseStyle, setCanAdaptWidth, setDefaultProperties, setDefiningProperty, setDisabledIconCursor, setHiliteAccessKey, setIconCursor, setIconOnlyBaseStyle, setIconStyle, setLogicalStructure, setOverflow, setRadioGroup, setShowClippedTitleOnHover, setShowDisabled, setShowDown, setShowFocused, setShowRollOver, setState, setTitle, setTitleHoverFormatter, titleClipped, titleHoverHTMLMethods inherited from class com.smartgwt.client.widgets.StatefulCanvas
getAriaLabel, getAriaStateDefaults, getIgnoreRTL, getLabelHPad, getLabelVPad, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getSelected, getShowFocusedAsOver, getShowMenuOnClick, getShowOverCanvas, getShowRTLIcon, getStateSuffix, getVIconStyle, isSelected, setAriaLabel, setDefaultProperties, setIgnoreRTL, setLabelHPad, setLabelVPad, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setSelected, setShowFocusedAsOver, setShowMenuOnClick, setShowOverCanvas, setShowRTLIcon, setTitleFormatter, setTitleStyle, setVIconStyleMethods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClearHandler, 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, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, 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, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, doValueDictation, doVoiceCommand, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, supportsValueDictation, supportsVoiceCommands, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, 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, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods 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, unsinkEventsMethods 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, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
Label
public Label() -
Label
-
Label
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- 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. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- 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. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
setAlign
Horizontal alignment of label text. See Alignment type for details. -
getAlign
Horizontal alignment of label text. See Alignment type for details. -
setAutoFit
If true, ignore the specified size of this widget and always size just large enough to accommodate the title. IfsetWidth()is explicitly called on an autoFit:true button, autoFit will be reset tofalse.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:
setAutoFitin classButton- Parameters:
autoFit- New autoFit value. Default value is null- Returns:
Labelinstance, for chaining setter calls- See Also:
-
getAutoFit
If true, ignore the specified size of this widget and always size just large enough to accommodate the title. IfsetWidth()is explicitly called on an autoFit:true button, autoFit will be reset tofalse.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:
getAutoFitin classButton- Returns:
- Current autoFit value. Default value is null
- See Also:
-
setContents
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
dynamicContentsis set,setContents()can also be called with no arguments to cause contents to be re-evaluated.- Overrides:
setContentsin classCanvas- Parameters:
contents- an HTML string to be set as the contents of this widget. Default value is " "- Returns:
Labelinstance, for chaining setter calls- See Also:
-
getContents
The contents of a canvas or label widget. Any HTML string is acceptable.- Overrides:
getContentsin classCanvas- Returns:
- Current contents value. Default value is " "
- See Also:
-
setDynamicContents
Dynamic contents allows the contents string to be treated as a simple but powerful template. When this attribute is set to true, JavaScript expressions may be embedded within the contents string, using the format:${[JavaScript to evaluate]}.For example, to include the current date in a templated message,
canvas.contentscould be set to:
"Today's date is <b>${new Date().toUSShortDate()}</b>"Embedded expressions will be evaluated when the canvas is drawn or redrawn, and the result of the evaluated expression will be displayed to the user. If the expression does not evaluate to a String, the
toString()representation of the returned object will be displayed automaticallyDynamic expressions are evaluated in the scope of the canvas displaying the content, so the
thiskeyword may be used within your expression to refer to the canvas. Developers may also explicitly supply values for variables to be used within the evaluation via theCanvas.dynamicContentsVarsproperty.Notes:
- Calling markForRedraw() on the canvas will evaluate any embedded expressions.
- Multiple such expressions may be embedded within the contents string for a component.
- If an error occurs during evaluation, a warning is logged to the
Developer Consoleand the error string will be embedded in place of the expected value in the Canvas.
Note : This is an advanced setting
- Overrides:
setDynamicContentsin classCanvas- Parameters:
dynamicContents- New dynamicContents value. Default value is false- Returns:
Labelinstance, for chaining setter calls- See Also:
-
setContents(java.lang.String)com.smartgwt.client.widgets.Canvas#setDynamicContentsVars
-
getDynamicContents
Dynamic contents allows the contents string to be treated as a simple but powerful template. When this attribute is set to true, JavaScript expressions may be embedded within the contents string, using the format:${[JavaScript to evaluate]}.For example, to include the current date in a templated message,
canvas.contentscould be set to:
"Today's date is <b>${new Date().toUSShortDate()}</b>"Embedded expressions will be evaluated when the canvas is drawn or redrawn, and the result of the evaluated expression will be displayed to the user. If the expression does not evaluate to a String, the
toString()representation of the returned object will be displayed automaticallyDynamic expressions are evaluated in the scope of the canvas displaying the content, so the
thiskeyword may be used within your expression to refer to the canvas. Developers may also explicitly supply values for variables to be used within the evaluation via theCanvas.dynamicContentsVarsproperty.Notes:
- Calling markForRedraw() on the canvas will evaluate any embedded expressions.
- Multiple such expressions may be embedded within the contents string for a component.
- If an error occurs during evaluation, a warning is logged to the
Developer Consoleand the error string will be embedded in place of the expected value in the Canvas.
- Overrides:
getDynamicContentsin classCanvas- Returns:
- Current dynamicContents value. Default value is false
- See Also:
-
getContents()com.smartgwt.client.widgets.Canvas#getDynamicContentsVars
-
setEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classStatefulCanvas- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "LabelEditProxy"- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classStatefulCanvas- Returns:
- Current editProxyConstructor value. Default value is "LabelEditProxy"
- See Also:
-
setHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
getHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
setHeight
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
getHeightAsString
Size for this component's vertical dimension. SeeCanvas.heightfor more details.Note that if
StatefulCanvas.autoFitis set on non-StretchImgButtoninstances, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
getHeightAsStringin classButton- Returns:
- Current height value. Default value is null
- See Also:
-
setIcon
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. A sprited image can be specified using the
SCSpriteConfigformat.Note that the string "blank" is a valid setting for this attribute and will always result in the system blank image, with no state suffixes applied. Typically, this might be used when an iconStyle is also specified and the iconStyle renders the icon via a stateful background-image or other CSS approach.
If this method is called after the component has been drawn/initialized: Change the icon being shown next to the title text. -
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. A sprited image can be specified using the
SCSpriteConfigformat.Note that the string "blank" is a valid setting for this attribute and will always result in the system blank image, with no state suffixes applied. Typically, this might be used when an iconStyle is also specified and the iconStyle renders the icon via a stateful background-image or other CSS approach.
-
setIconAlign
If this button is showing an icon should it be right or left aligned?- Overrides:
setIconAlignin classButton- Parameters:
iconAlign- New iconAlign value. Default value is null- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconAlign
If this button is showing an icon should it be right or left aligned?- Overrides:
getIconAlignin classButton- Returns:
- Current iconAlign value. Default value is null
- See Also:
-
setIconHeight
Height in pixels of the icon image.If unset, defaults to
iconSize.- Overrides:
setIconHeightin classButton- Parameters:
iconHeight- New iconHeight value. Default value is null- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconHeight
Height in pixels of the icon image.If unset, defaults to
iconSize.- Overrides:
getIconHeightin classButton- Returns:
- Current iconHeight value. Default value is null
- See Also:
-
setIconOrientation
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:
setIconOrientationin classButton- Parameters:
iconOrientation- The new orientation of the icon relative to the text of the button. Default value is "left"- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
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:
getIconOrientationin classButton- Returns:
- Current iconOrientation value. Default value is "left"
- See Also:
-
setIconSize
Size in pixels of the icon image.The
iconWidthandiconHeightproperties can be used to configure width and height separately.Note: When configuring the properties of a
StatefulCanvas(or derivative)AutoChild, it is best to set theiconWidthandiconHeightto the same value rather than setting aniconSize. This is because certain skins or customizations thereto might set theiconWidthandiconHeight, making the customization of the AutoChild'siconSizeineffective.- Overrides:
setIconSizein classButton- Parameters:
iconSize- New iconSize value. Default value is 16- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconSize
public int getIconSize()Size in pixels of the icon image.The
iconWidthandiconHeightproperties can be used to configure width and height separately.Note: When configuring the properties of a
StatefulCanvas(or derivative)AutoChild, it is best to set theiconWidthandiconHeightto the same value rather than setting aniconSize. This is because certain skins or customizations thereto might set theiconWidthandiconHeight, making the customization of the AutoChild'siconSizeineffective.- Overrides:
getIconSizein classButton- Returns:
- Current iconSize value. Default value is 16
- See Also:
-
setIconSpacing
Pixels between icon and title text.- Overrides:
setIconSpacingin classButton- Parameters:
iconSpacing- New iconSpacing value. Default value is 6- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconSpacing
public int getIconSpacing()Pixels between icon and title text.- Overrides:
getIconSpacingin classButton- Returns:
- Current iconSpacing value. Default value is 6
- See Also:
-
setIconWidth
Width in pixels of the icon image.If unset, defaults to
iconSize.- Overrides:
setIconWidthin classButton- Parameters:
iconWidth- New iconWidth value. Default value is null- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getIconWidth
Width in pixels of the icon image.If unset, defaults to
iconSize.- Overrides:
getIconWidthin classButton- Returns:
- Current iconWidth value. Default value is null
- See Also:
-
setShowDisabledIcon
If using an icon for this button, whether to switch the icon image if the button becomes disabled.- Overrides:
setShowDisabledIconin classButton- Parameters:
showDisabledIcon- New showDisabledIcon value. Default value is true- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowDisabledIcon
If using an icon for this button, whether to switch the icon image if the button becomes disabled.- Overrides:
getShowDisabledIconin classButton- Returns:
- Current showDisabledIcon value. Default value is true
- See Also:
-
setShowDownIcon
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.- Overrides:
setShowDownIconin classButton- Parameters:
showDownIcon- New showDownIcon value. Default value is false- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowDownIcon
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.- Overrides:
getShowDownIconin classButton- Returns:
- Current showDownIcon value. Default value is false
- See Also:
-
setShowFocusedIcon
If using an icon for this button, whether to switch the icon image when the button receives focus.If
StatefulCanvas.showFocusedAsOveris true, the"Over"icon will be displayed when the canvas has focus, otherwise a separate"Focused"icon will be displayed- Overrides:
setShowFocusedIconin classButton- Parameters:
showFocusedIcon- New showFocusedIcon value. Default value is false- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowFocusedIcon
If using an icon for this button, whether to switch the icon image when the button receives focus.If
StatefulCanvas.showFocusedAsOveris true, the"Over"icon will be displayed when the canvas has focus, otherwise a separate"Focused"icon will be displayed- Overrides:
getShowFocusedIconin classButton- Returns:
- Current showFocusedIcon value. Default value is false
- See Also:
-
setShowRollOverIcon
If using an icon for this button, whether to switch the icon image on mouse rollover.- Overrides:
setShowRollOverIconin classButton- Parameters:
showRollOverIcon- New showRollOverIcon value. Default value is false- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowRollOverIcon
If using an icon for this button, whether to switch the icon image on mouse rollover.- Overrides:
getShowRollOverIconin classButton- Returns:
- Current showRollOverIcon value. Default value is false
- See Also:
-
setShowSelectedIcon
If using an icon for this button, whether to switch the icon image when the button becomes selected.- Overrides:
setShowSelectedIconin classButton- Parameters:
showSelectedIcon- New showSelectedIcon value. Default value is false- Returns:
Labelinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getShowSelectedIcon
If using an icon for this button, whether to switch the icon image when the button becomes selected.- Overrides:
getShowSelectedIconin classButton- Returns:
- Current showSelectedIcon value. Default value is false
- See Also:
-
setStyleName
Set the CSS class for this widget. For a Label, this is equivalent to settingButton.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 tosetBaseStyle().- Overrides:
setStyleNamein classButton- Parameters:
styleName- new CSS style name. Default value is "normal"- See Also:
-
getStyleName
Set the CSS class for this widget. For a Label, this is equivalent to settingButton.baseStyle.- Overrides:
getStyleNamein classButton- Returns:
- Current styleName value. Default value is "normal"
- See Also:
-
setValign
Vertical alignment of label text. See VerticalAlignment type for details. -
getValign
Vertical alignment of label text. See VerticalAlignment type for details. -
setWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
getWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
setWidth
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title. -
getWidthAsString
Size for this component's horizontal dimension. SeeCanvas.widthfor more details.Note that if
StatefulCanvas.autoFitis set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.- Overrides:
getWidthAsStringin classButton- Returns:
- Current width value. Default value is null
- See Also:
-
setWrap
If false, the label text will not be wrapped to the next line. -
getWrap
If false, the label text will not be wrapped to the next line. -
setDefaultProperties
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- See Also:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classButton
-