public class Label extends Button
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName| Constructor and Description |
|---|
Label() |
Label(com.google.gwt.core.client.JavaScriptObject jsObj) |
Label(java.lang.String contents) |
| Modifier and Type | Method and Description |
|---|---|
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 |
getEditProxyConstructor()
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
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()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
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 |
setEditProxyConstructor(java.lang.String editProxyConstructor)
Default class used to construct the
EditProxy for this component when the component is
first placed into edit mode. |
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)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
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.
|
action, addIconClickHandler, addTitleHoverHandler, addToRadioGroup, deselect, getActionType, getBaseStyle, getDisabledIconCursor, getHiliteAccessKey, getIconCursor, getIconStyle, getRadioGroup, getSelected, getShowClippedTitleOnHover, getShowDisabled, getShowDown, getShowFocused, getShowRollOver, getState, getTitle, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setBaseStyle, setDefaultProperties, setDisabledIconCursor, setHiliteAccessKey, setIconCursor, setIconStyle, setLogicalStructure, setRadioGroup, setSelected, setShowClippedTitleOnHover, setShowDisabled, setShowDown, setShowFocused, setShowRollOver, setState, setTitle, setTitleHoverFormatter, titleClipped, titleHoverHTMLgetIgnoreRTL, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getShowRTLIcon, getStateSuffix, setDefaultProperties, setIgnoreRTL, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas, setShowRTLIcon, setTitleStyleaddChild, 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, addSnapAlignCandidate, 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, encloses, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, 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, getIsPrinting, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, 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, printComponents, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoMaskComponents, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, 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, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeavePageSpace, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDropaddDrawHandler, applyFactoryProperties, 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, 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, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic Label()
public Label(com.google.gwt.core.client.JavaScriptObject jsObj)
public Label(java.lang.String contents)
public static Label getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.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, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.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, see SGWTProperties.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
public void setAlign(Alignment align)
setAlign in class Buttonalign - Default value is Canvas.LEFTPositioning overview and related methodspublic Alignment getAlign()
getAlign in class ButtonPositioning overview and related methodspublic void setAutoFit(java.lang.Boolean autoFit)
setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false. Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
setAutoFit in class ButtonautoFit - Default value is nullSizing overview and related methodspublic java.lang.Boolean getAutoFit()
setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false. Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
getAutoFit in class ButtonSizing overview and related methodspublic void setContents(java.lang.String contents)
When dynamicContents is set, setContents() can also be called with no arguments to cause contents to be re-evaluated.
setContents in class Canvascontents - an HTML string to be set as the contents of this widget See HTMLString . Default value is " "setDynamicContents(java.lang.Boolean)public java.lang.String getContents()
getContents in class CanvasHTMLStringgetDynamicContents()public void setDynamicContents(java.lang.Boolean dynamicContents)
You can use this feature to build some simple custom components. For example, let's say you want to show the value of a Slider in a Canvas somewhere on the screen. You can do this by observing the valueChanged() method on the slider and calling setContents() on your canvas with the new string or you can set the contents of the canvas to something like:
"The slider value is ${sliderInstance.getValue()}."
Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider and call canvas.markForRedraw() in that observation. This approach is cleaner than setContents() when the Canvas is aggregating several values or dynamic expressions. Like so:
Slider.create({
ID: "mySlider"
});
Canvas.create({
ID: "myCanvas",
dynamicContents: true,
contents: "The slider value is ${mySlider.getValue()}."
});
myCanvas.observe(mySlider, "valueChanged",
"observer.markForRedraw()");
You can embed an arbitrary number of dynamic expressions in the contents string. The
search and replace is optimized for speed.
If an error occurs during the evaluation of one of the expressions, a warning is logged to the ISC Developer Console and the error string is embedded in place of the expected value in the Canvas.
The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
Inside the 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
setDynamicContents in class CanvasdynamicContents - Default value is falsesetContents(java.lang.String),
com.smartgwt.client.widgets.Canvas#setDynamicContentsVarspublic java.lang.Boolean getDynamicContents()
You can use this feature to build some simple custom components. For example, let's say you want to show the value of a Slider in a Canvas somewhere on the screen. You can do this by observing the valueChanged() method on the slider and calling setContents() on your canvas with the new string or you can set the contents of the canvas to something like:
"The slider value is ${sliderInstance.getValue()}."
Next you set dynamicContents: true on the canvas, observe valueChanged() on the slider and call canvas.markForRedraw() in that observation. This approach is cleaner than setContents() when the Canvas is aggregating several values or dynamic expressions. Like so:
Slider.create({
ID: "mySlider"
});
Canvas.create({
ID: "myCanvas",
dynamicContents: true,
contents: "The slider value is ${mySlider.getValue()}."
});
myCanvas.observe(mySlider, "valueChanged",
"observer.markForRedraw()");
You can embed an arbitrary number of dynamic expressions in the contents string. The
search and replace is optimized for speed.
If an error occurs during the evaluation of one of the expressions, a warning is logged to the ISC Developer Console and the error string is embedded in place of the expected value in the Canvas.
The value of a function is its return value. The value of any variable is the same as that returned by its toString() representation.
Inside the 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.
getDynamicContents in class CanvasgetContents(),
com.smartgwt.client.widgets.Canvas#getDynamicContentsVarspublic void setEditProxyConstructor(java.lang.String editProxyConstructor)
throws java.lang.IllegalStateException
EditProxy for this component when the component is
first placed into edit mode.setEditProxyConstructor in class StatefulCanvaseditProxyConstructor - See SCClassName . Default value is "LabelEditProxy"java.lang.IllegalStateException - this property cannot be changed after the component has been createdpublic java.lang.String getEditProxyConstructor()
EditProxy for this component when the component is
first placed into edit mode.getEditProxyConstructor in class StatefulCanvasSCClassNamepublic void setIcon(java.lang.String icon)
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.
setIcon in class Buttonicon - URL of new icon See SCImgURL . Default value is nullButtonIcon overview and related methodspublic java.lang.String getIcon()
Specify as the partial URL to an image, relative to the imgDir of this component.
getIcon in class ButtonSCImgURLButtonIcon overview and related methodspublic void setIconAlign(java.lang.String iconAlign)
throws java.lang.IllegalStateException
setIconAlign in class ButtoniconAlign - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.String getIconAlign()
getIconAlign in class ButtonButtonIcon overview and related methodspublic void setIconHeight(java.lang.Integer iconHeight)
throws java.lang.IllegalStateException
If unset, defaults to iconSize.
setIconHeight in class ButtoniconHeight - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconHeight()
If unset, defaults to iconSize.
getIconHeight in class ButtonButtonIcon overview and related methodspublic void setIconOrientation(java.lang.String iconOrientation)
throws java.lang.IllegalStateException
"left" and "right".
setIconOrientation in class ButtoniconOrientation - The new orientation of the icon relative to the text of the button.. Default value is "left"java.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.String getIconOrientation()
"left" and "right".getIconOrientation in class ButtonButtonIcon overview and related methodspublic void setIconSize(int iconSize)
throws java.lang.IllegalStateException
The iconWidth and
iconHeight properties 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 the iconWidth and iconHeight
to the same value rather than setting an iconSize. This is because certain skins or customizations thereto
might set the iconWidth and iconHeight, making the customization of the AutoChild's
iconSize ineffective.
setIconSize in class ButtoniconSize - Default value is 16java.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic int getIconSize()
The iconWidth and
iconHeight properties 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 the iconWidth and iconHeight
to the same value rather than setting an iconSize. This is because certain skins or customizations thereto
might set the iconWidth and iconHeight, making the customization of the AutoChild's
iconSize ineffective.
getIconSize in class ButtonButtonIcon overview and related methodspublic void setIconSpacing(int iconSpacing)
throws java.lang.IllegalStateException
iconSpacing - Default value is 6java.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic int getIconSpacing()
ButtonIcon overview and related methodspublic void setIconWidth(java.lang.Integer iconWidth)
throws java.lang.IllegalStateException
If unset, defaults to iconSize.
setIconWidth in class ButtoniconWidth - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconWidth()
If unset, defaults to iconSize.
getIconWidth in class ButtonButtonIcon overview and related methodspublic void setShowDisabledIcon(java.lang.Boolean showDisabledIcon)
throws java.lang.IllegalStateException
setShowDisabledIcon in class ButtonshowDisabledIcon - Default value is truejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowDisabledIcon()
getShowDisabledIcon in class ButtonButtonIcon overview and related methodspublic void setShowDownIcon(java.lang.Boolean showDownIcon)
throws java.lang.IllegalStateException
setShowDownIcon in class ButtonshowDownIcon - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowDownIcon()
getShowDownIcon in class ButtonButtonIcon overview and related methodspublic void setShowFocusedIcon(java.lang.Boolean showFocusedIcon)
throws java.lang.IllegalStateException
If StatefulCanvas.showFocusedAsOver is true, the
"Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon
will be displayed
setShowFocusedIcon in class ButtonshowFocusedIcon - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowFocusedIcon()
If StatefulCanvas.showFocusedAsOver is true, the
"Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon
will be displayed
getShowFocusedIcon in class ButtonButtonIcon overview and related methodspublic void setShowRollOverIcon(java.lang.Boolean showRollOverIcon)
throws java.lang.IllegalStateException
setShowRollOverIcon in class ButtonshowRollOverIcon - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowRollOverIcon()
getShowRollOverIcon in class ButtonButtonIcon overview and related methodspublic void setShowSelectedIcon(java.lang.Boolean showSelectedIcon)
throws java.lang.IllegalStateException
setShowSelectedIcon in class ButtonshowSelectedIcon - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowSelectedIcon()
getShowSelectedIcon in class ButtonButtonIcon overview and related methodspublic void setStyleName(java.lang.String styleName)
Button.baseStyle.
setBaseStyle().setStyleName in class CanvasstyleName - new CSS style name See CSSStyleName . Default value is "normal"Appearance overview and related methods,
CSS styles Examplepublic java.lang.String getStyleName()
Button.baseStyle.getStyleName in class CanvasCSSStyleNameAppearance overview and related methods,
CSS styles Examplepublic void setValign(VerticalAlignment valign)
setValign in class Buttonvalign - Default value is Canvas.CENTERPositioning overview and related methodspublic VerticalAlignment getValign()
getValign in class ButtonPositioning overview and related methodspublic void setWrap(java.lang.Boolean wrap)
setWrap in class Buttonwrap - Default value is trueSizing overview and related methodspublic java.lang.Boolean getWrap()
getWrap in class ButtonSizing overview and related methodspublic static void setDefaultProperties(Label labelProperties)
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.
labelProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.LabelLogicalStructure s)
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility.getLogicalStructure in interface LogicalStructuregetLogicalStructure in class Button