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:
HasHandlers, com.google.gwt.user.client.EventListener, 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, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers
Direct Known Subclasses:
SectionHeader, ViewLoader

public class Label
extends Button

Labels display a small amount of align contents with optional icon and autoFit.

For a general-purpose container for HTML content, use HTMLFlow or HTMLPane instead.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Label()
           
Label(com.google.gwt.core.client.JavaScriptObject jsObj)
           
Label(java.lang.String contents)
           
 
Method Summary
protected  com.google.gwt.core.client.JavaScriptObject create()
           
 Alignment getAlign()
          Horizontal alignment of label text.
 java.lang.Boolean getAutoFit()
          If true, ignore the specified size of this widget and always size just large enough to accomodate the title.
 java.lang.String getContents()
          The contents of a canvas or label widget.
 java.lang.Boolean getDynamicContents()
          Dynamic contents allows the contents string to be treated as a simple, but powerful template.
 java.lang.String getIcon()
          Optional icon to be shown with the button title text.
 java.lang.String getIconAlign()
          If this button is showing an icon should it be right or left aligned?
 java.lang.Integer getIconHeight()
          Height in pixels of the icon image.
 java.lang.String getIconOrientation()
          If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right".
 int getIconSize()
          Size in pixels of the icon image.
 int getIconSpacing()
          Pixels between icon and title text.
 java.lang.Integer getIconWidth()
          Width in pixels of the icon image.
static Label getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean getShowDisabledIcon()
          If using an icon for this button, whether to switch the icon image if the button becomes disabled.
 java.lang.Boolean getShowDownIcon()
          If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
 java.lang.Boolean getShowFocusedIcon()
          If using an icon for this button, whether to switch the icon image when the button recieves focus.
 java.lang.Boolean getShowRollOverIcon()
          If using an icon for this button, whether to switch the icon image on mouse rollover.
 java.lang.Boolean getShowSelectedIcon()
          If using an icon for this button, whether to switch the icon image when the button becomes selected.
 VerticalAlignment getValign()
          Vertical alignment of label text.
 java.lang.Boolean getWrap()
          If false, the label text will not be wrapped to the next line.
 void setAlign(Alignment align)
          Horizontal alignment of label text.
 void setAutoFit(java.lang.Boolean autoFit)
          If true, ignore the specified size of this widget and always size just large enough to accomodate the title.
 void setContents(java.lang.String contents)
          The contents of a canvas or label widget.
 void setDynamicContents(java.lang.Boolean dynamicContents)
          Dynamic contents allows the contents string to be treated as a simple, but powerful template.
 void setIcon(java.lang.String icon)
          Optional icon to be shown with the button title text.
 void setIconAlign(java.lang.String iconAlign)
          If this button is showing an icon should it be right or left aligned?
 void setIconHeight(java.lang.Integer iconHeight)
          Height in pixels of the icon image.
 void setIconOrientation(java.lang.String iconOrientation)
          If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right".
 void setIconSize(int iconSize)
          Size in pixels of the icon image.
 void setIconSpacing(int iconSpacing)
          Pixels between icon and title text.
 void setIconWidth(java.lang.Integer iconWidth)
          Width in pixels of the icon image.
 void setShowDisabledIcon(java.lang.Boolean showDisabledIcon)
          If using an icon for this button, whether to switch the icon image if the button becomes disabled.
 void setShowDownIcon(java.lang.Boolean showDownIcon)
          If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
 void setShowFocusedIcon(java.lang.Boolean showFocusedIcon)
          If using an icon for this button, whether to switch the icon image when the button recieves focus.
 void setShowRollOverIcon(java.lang.Boolean showRollOverIcon)
          If using an icon for this button, whether to switch the icon image on mouse rollover.
 void setShowSelectedIcon(java.lang.Boolean showSelectedIcon)
          If using an icon for this button, whether to switch the icon image when the button becomes selected.
 void setValign(VerticalAlignment valign)
          Vertical alignment of label text.
 void setWrap(java.lang.Boolean wrap)
          If false, the label text will not be wrapped to the next line.
 
Methods inherited from class com.smartgwt.client.widgets.Button
action, addIconClickHandler, addToRadioGroup, deselect, getActionType, getBaseStyle, getHiliteAccessKey, getRadioGroup, getSelected, getShowDisabled, getShowDown, getShowFocused, getShowRollOver, getState, getTitle, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setBaseStyle, setDisabled, setHiliteAccessKey, setRadioGroup, setSelected, setShowDisabled, setShowDown, setShowFocused, setShowRollOver, setState, setTitle, setVAlign
 
Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas
getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getStateSuffix, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas, setTitleStyle
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContextMenu, getCursor, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTooltip, getTop, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, parentResized, redraw, redraw, removeChild, removeChild, resizeBy, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContextMenu, setCursor, setDefaultHeight, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showNextTo, showNextTo, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, onInit, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

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)

create

protected com.google.gwt.core.client.JavaScriptObject create()
Overrides:
create in class Button

setContents

public void setContents(java.lang.String contents)
The contents of a canvas or label widget. Any HTML string is acceptable. 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. Default value is " "

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:
String

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 evalution contentext, this points to the canvas instance that has the dynamicContents string as its contents - in other words the canvas instance on which the template is declared.

Note : This is an advanced setting

Overrides:
setDynamicContents in class Canvas
Parameters:
dynamicContents - dynamicContents Default value is false

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 evalution contentext, this points to the canvas instance that has the dynamicContents string as its contents - in other words the canvas instance on which the template is declared.

Overrides:
getDynamicContents in class Canvas
Returns:
Boolean

setAlign

public void setAlign(Alignment align)
Horizontal alignment of label text. See Alignment type for details.

Overrides:
setAlign in class Button
Parameters:
align - align Default value is Canvas.LEFT

getAlign

public Alignment getAlign()
Horizontal alignment of label text. See Alignment type for details.

Overrides:
getAlign in class Button
Returns:
Alignment

setValign

public void setValign(VerticalAlignment valign)
Vertical alignment of label text. See VerticalAlignment type for details.

Overrides:
setValign in class Button
Parameters:
valign - valign Default value is Canvas.CENTER

getValign

public VerticalAlignment getValign()
Vertical alignment of label text. See VerticalAlignment type for details.

Overrides:
getValign in class Button
Returns:
VerticalAlignment

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 - wrap Default value is true

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

setAutoFit

public void setAutoFit(java.lang.Boolean autoFit)
If true, ignore the specified size of this widget and always size just large enough to accomodate the title. If setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false.

Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"

Overrides:
setAutoFit in class Button
Parameters:
autoFit - autoFit Default value is null

getAutoFit

public java.lang.Boolean getAutoFit()
If true, ignore the specified size of this widget and always size just large enough to accomodate 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

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. Change the icon being shown next to the title text.

Overrides:
setIcon in class Button
Parameters:
icon - URL of new icon. Default value is null

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:
String

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 - iconSize Default value is 16
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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

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 - iconWidth Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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

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 - iconHeight Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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

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

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

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 - iconAlign Default value is null
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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

setIconSpacing

public void setIconSpacing(int iconSpacing)
                    throws java.lang.IllegalStateException
Pixels between icon and title text.

Parameters:
iconSpacing - iconSpacing Default value is 6
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getIconSpacing

public int getIconSpacing()
Pixels between icon and title text.

Returns:
int

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 - showDisabledIcon Default value is true
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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

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 - showRollOverIcon Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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

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 recieves focus.

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

Overrides:
setShowFocusedIcon in class Button
Parameters:
showFocusedIcon - showFocusedIcon Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

getShowFocusedIcon

public java.lang.Boolean getShowFocusedIcon()
If using an icon for this button, whether to switch the icon image when the button recieves focus.

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

Overrides:
getShowFocusedIcon in class Button
Returns:
Boolean

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 - showDownIcon Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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

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 - showSelectedIcon Default value is false
Throws:
java.lang.IllegalStateException - this property cannot be changed after the component has been created

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