com.smartgwt.client.widgets
Class ImgButton

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.Img
                          extended by com.smartgwt.client.widgets.ImgButton
All Implemented Interfaces:
HasHandlers, EventListener, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers
Direct Known Subclasses:
TransferImgButton

public class ImgButton
extends Img

A Img that behaves like a button, going through up/down/over state transitions in response to user events. Supports an optional title, and will auto-size to accomodate the title text if overflow is set to "visible".

An examples of use is Window minimize/close buttons.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet, scClassName
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ImgButton()
           
ImgButton(JavaScriptObject jsObj)
           
 
Method Summary
 void action()
          This property contains the default 'action' for the Button to fire when activated.
 void addToRadioGroup(String groupID)
          Add this widget to the specified mutually exclusive selection group with the ID passed in.
protected  JavaScriptObject create()
           
 void deselect()
          Select this object.
 SelectionType getActionType()
          Behavior on state changes -- BUTTON, RADIO or CHECKBOX
 Alignment getAlign()
          Horizontal alignment of this component's title.
 Boolean getAutoFit()
          If true, ignore the specified size of this widget and always size just large enough to accomodate the title.
 String getBaseStyle()
          Base CSS style.
 Boolean getHiliteAccessKey()
          If set to true, if the 'title' of this button contains the specified 'accessKey', when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.
 String getIcon()
          Optional icon to be shown with the button title text.
 String getIconAlign()
          If this button is showing an icon should it be right or left aligned?
 Integer getIconHeight()
          Height in pixels of the icon image.
 String getIconOrientation()
          If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right".
 int getIconSize()
          Size in pixels of the icon image.
 int getIconSpacing()
          Pixels between icon and title text.
 Integer getIconWidth()
          Width in pixels of the icon image.
 Integer getLabelHPad()
          Horizontal padding to be applied to this widget's label.
 Integer getLabelVPad()
          Vertical padding to be applied to this widget's label.
static ImgButton getOrCreateRef(JavaScriptObject jsObj)
           
 String getRadioGroup()
          String identifier for this canvas's mutually exclusive selection group.
 Boolean getSelected()
          Whether this component is selected.
 Boolean getShowDisabled()
          Should we visibly change state when disabled?
 Boolean getShowDisabledIcon()
          If using an icon for this button, whether to switch the icon image if the button becomes disabled.
 Boolean getShowDown()
          Should we visibly change state when the mouse goes down in this object?
 Boolean getShowDownIcon()
          If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
 Boolean getShowFocused()
          Should we visibly change state when the canvas recieves focus? If showFocusedAsOver is true, the "over" will be used to indicate focus.
 Boolean getShowFocusedIcon()
          If using an icon for this button, whether to switch the icon image when the button recieves focus.
 Boolean getShowRollOver()
          Should we visibly change state when the mouse goes over this object?
 Boolean getShowRollOverIcon()
          If using an icon for this button, whether to switch the icon image on mouse rollover.
 Boolean getShowSelectedIcon()
          If using an icon for this button, whether to switch the icon image when the button becomes selected.
 Boolean getShowTitle()
          Determines whether any specified StatefulCanvas.getTitle() will be displayed for this component.
Applies to Image-based components only, where the title will be rendered out in a label floating over the component
 String getSrc()
          The base filename for the image.
 State getState()
          Current "state" of this widget.
 String getTitle()
          The text title to display in this button.
 VerticalAlignment getValign()
          Vertical alignment of this component's title.
 Boolean isSelected()
          Find out if this object is selected
 void removeFromRadioGroup()
          Remove this widget from the specified mutually exclusive selection group with the ID passed in.
 void removeFromRadioGroup(String groupID)
          Remove this widget from the specified mutually exclusive selection group with the ID passed in.
 void select()
          Select this object.
 void setActionType(SelectionType actionType)
          Behavior on state changes -- BUTTON, RADIO or CHECKBOX Update the 'actionType' for this canvas (radio / checkbox / button) If the canvas is currently selected, and the passed in actionType is 'button' this method will deselect the canvas.
 void setAlign(Alignment align)
          Horizontal alignment of this component's title.
 void setAutoFit(Boolean autoFit)
          If true, ignore the specified size of this widget and always size just large enough to accomodate the title.
 void setBaseStyle(String baseStyle)
          Base CSS style.
 void setDisabled(boolean disabled)
          Enable or disable this object
 void setHiliteAccessKey(Boolean hiliteAccessKey)
          If set to true, if the 'title' of this button contains the specified 'accessKey', when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.
 void setIcon(String icon)
          Optional icon to be shown with the button title text.
 void setIconAlign(String iconAlign)
          If this button is showing an icon should it be right or left aligned?
 void setIconHeight(Integer iconHeight)
          Height in pixels of the icon image.
 void setIconOrientation(String iconOrientation)
          If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right".
 void setIconSize(int iconSize)
          Size in pixels of the icon image.
 void setIconSpacing(int iconSpacing)
          Pixels between icon and title text.
 void setIconWidth(Integer iconWidth)
          Width in pixels of the icon image.
 void setLabelHPad(Integer labelHPad)
          Horizontal padding to be applied to this widget's label.
 void setLabelVPad(Integer labelVPad)
          Vertical padding to be applied to this widget's label.
 void setRadioGroup(String radioGroup)
          String identifier for this canvas's mutually exclusive selection group.
 void setSelected(Boolean selected)
          Whether this component is selected.
 void setShowDisabled(Boolean showDisabled)
          Should we visibly change state when disabled?
 void setShowDisabledIcon(Boolean showDisabledIcon)
          If using an icon for this button, whether to switch the icon image if the button becomes disabled.
 void setShowDown(Boolean showDown)
          Should we visibly change state when the mouse goes down in this object?
 void setShowDownIcon(Boolean showDownIcon)
          If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.
 void setShowFocused(Boolean showFocused)
          Should we visibly change state when the canvas recieves focus? If showFocusedAsOver is true, the "over" will be used to indicate focus.
 void setShowFocusedIcon(Boolean showFocusedIcon)
          If using an icon for this button, whether to switch the icon image when the button recieves focus.
 void setShowRollOver(Boolean showRollOver)
          Should we visibly change state when the mouse goes over this object?
 void setShowRollOverIcon(Boolean showRollOverIcon)
          If using an icon for this button, whether to switch the icon image on mouse rollover.
 void setShowSelectedIcon(Boolean showSelectedIcon)
          If using an icon for this button, whether to switch the icon image when the button becomes selected.
 void setShowTitle(Boolean showTitle)
          Determines whether any specified StatefulCanvas.getTitle() will be displayed for this component.
Applies to Image-based components only, where the title will be rendered out in a label floating over the component
 void setSrc(String src)
          The base filename for the image.
 void setState(State state)
          Current "state" of this widget.
 void setTitle(String title)
          The text title to display in this button.
 void setValign(VerticalAlignment valign)
          Vertical alignment of this component's title.
 
Methods inherited from class com.smartgwt.client.widgets.Img
getImageHeight, getImageType, getImageWidth, getSize, resetSrc, setImageHeight, setImageType, setImageWidth, setName, setSize
 
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, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFullDataPath, 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, getLeftAsString, 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, getTopAsString, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, parentResized, redraw, redraw, removeChild, removeChild, 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, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultWidth, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, 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, 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, setTop, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, 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
addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, 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

ImgButton

public ImgButton()

ImgButton

public ImgButton(JavaScriptObject jsObj)
Method Detail

getOrCreateRef

public static ImgButton getOrCreateRef(JavaScriptObject jsObj)

create

protected JavaScriptObject create()
Overrides:
create in class Img

setTitle

public void setTitle(String title)
The text title to display in this button. Set the title.

Overrides:
setTitle in class StatefulCanvas
Parameters:
title - new title. Default value is varies

getTitle

public String getTitle()
The text title to display in this button.

Overrides:
getTitle in class StatefulCanvas
Returns:
Return the title - text/HTML drawn inside the component.

Default is to simply return this.title.


setHiliteAccessKey

public void setHiliteAccessKey(Boolean hiliteAccessKey)
If set to true, if the 'title' of this button contains the specified 'accessKey', when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.

Parameters:
hiliteAccessKey - hiliteAccessKey Default value is null

getHiliteAccessKey

public Boolean getHiliteAccessKey()
If set to true, if the 'title' of this button contains the specified 'accessKey', when the title is displayed to the user it will be modified to include HTML to underline the accessKey.
Note that this property may cause titles that include HTML (rather than simple strings) to be inappropriately modified, so should be disabled if your title string includes HTML characters.

Returns:
Boolean

setIcon

public void setIcon(String icon)
Optional icon to be shown with the button title text.

Specify as the partial URL to an image, relative to the imgDir of this component. Change the icon being shown next to the title text.

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

getIcon

public String getIcon()
Optional icon to be shown with the button title text.

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

Overrides:
getIcon in class StatefulCanvas
Returns:
String

setIconSize

public void setIconSize(int iconSize)
                 throws IllegalStateException
Size in pixels of the icon image.

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

Overrides:
setIconSize in class StatefulCanvas
Parameters:
iconSize - iconSize Default value is 16
Throws:
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 StatefulCanvas
Returns:
int

setIconWidth

public void setIconWidth(Integer iconWidth)
                  throws IllegalStateException
Width in pixels of the icon image.

If unset, defaults to iconSize

Overrides:
setIconWidth in class StatefulCanvas
Parameters:
iconWidth - iconWidth Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getIconWidth

public Integer getIconWidth()
Width in pixels of the icon image.

If unset, defaults to iconSize

Overrides:
getIconWidth in class StatefulCanvas
Returns:
Integer

setIconHeight

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

If unset, defaults to iconSize

Overrides:
setIconHeight in class StatefulCanvas
Parameters:
iconHeight - iconHeight Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getIconHeight

public Integer getIconHeight()
Height in pixels of the icon image.

If unset, defaults to iconSize

Overrides:
getIconHeight in class StatefulCanvas
Returns:
Integer

setIconOrientation

public void setIconOrientation(String iconOrientation)
                        throws IllegalStateException
If this button is showing an icon should it appear to the left or right of the title? valid options are "left" and "right". Changes the orientation of the icon relative to the text of the button.

Overrides:
setIconOrientation in class StatefulCanvas
Parameters:
iconOrientation - The new orientation of the icon relative to the text of the button.. Default value is "left"
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getIconOrientation

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

Overrides:
getIconOrientation in class StatefulCanvas
Returns:
String

setIconAlign

public void setIconAlign(String iconAlign)
                  throws IllegalStateException
If this button is showing an icon should it be right or left aligned?

Parameters:
iconAlign - iconAlign Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getIconAlign

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

Returns:
String

setIconSpacing

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

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

getIconSpacing

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

Returns:
int

setShowDisabledIcon

public void setShowDisabledIcon(Boolean showDisabledIcon)
                         throws IllegalStateException
If using an icon for this button, whether to switch the icon image if the button becomes disabled.

Overrides:
setShowDisabledIcon in class StatefulCanvas
Parameters:
showDisabledIcon - showDisabledIcon Default value is true
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getShowDisabledIcon

public Boolean getShowDisabledIcon()
If using an icon for this button, whether to switch the icon image if the button becomes disabled.

Overrides:
getShowDisabledIcon in class StatefulCanvas
Returns:
Boolean

setShowRollOverIcon

public void setShowRollOverIcon(Boolean showRollOverIcon)
                         throws IllegalStateException
If using an icon for this button, whether to switch the icon image on mouse rollover.

Overrides:
setShowRollOverIcon in class StatefulCanvas
Parameters:
showRollOverIcon - showRollOverIcon Default value is false
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getShowRollOverIcon

public Boolean getShowRollOverIcon()
If using an icon for this button, whether to switch the icon image on mouse rollover.

Overrides:
getShowRollOverIcon in class StatefulCanvas
Returns:
Boolean

setShowFocusedIcon

public void setShowFocusedIcon(Boolean showFocusedIcon)
                        throws 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 StatefulCanvas
Parameters:
showFocusedIcon - showFocusedIcon Default value is false
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getShowFocusedIcon

public 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 StatefulCanvas
Returns:
Boolean

setShowDownIcon

public void setShowDownIcon(Boolean showDownIcon)
                     throws IllegalStateException
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.

Overrides:
setShowDownIcon in class StatefulCanvas
Parameters:
showDownIcon - showDownIcon Default value is false
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getShowDownIcon

public Boolean getShowDownIcon()
If using an icon for this button, whether to switch the icon image when the mouse goes down on the button.

Overrides:
getShowDownIcon in class StatefulCanvas
Returns:
Boolean

setShowSelectedIcon

public void setShowSelectedIcon(Boolean showSelectedIcon)
                         throws IllegalStateException
If using an icon for this button, whether to switch the icon image when the button becomes selected.

Overrides:
setShowSelectedIcon in class StatefulCanvas
Parameters:
showSelectedIcon - showSelectedIcon Default value is false
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getShowSelectedIcon

public Boolean getShowSelectedIcon()
If using an icon for this button, whether to switch the icon image when the button becomes selected.

Overrides:
getShowSelectedIcon in class StatefulCanvas
Returns:
Boolean

setAutoFit

public void setAutoFit(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" Setter method for the autoFit property. Pass in true or false to turn autoFit on or off. When autoFit is set to false, canvas will be resized to it's previously specified size.

Overrides:
setAutoFit in class StatefulCanvas
Parameters:
autoFit - New autoFit setting.. Default value is null

getAutoFit

public 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 StatefulCanvas
Returns:
Boolean

setBaseStyle

public void setBaseStyle(String baseStyle)
Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".

If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.

If the widget has focus and showFocused is true, and showFocusedAsOver is false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused, "SelectedFocused", "SelectedFocusedOver", etc.

For example, if baseStyle is set to "button", this component is isSelected() and the mouse cursor is over this component, the style "buttonSelectedOver" will be used. Sets the base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

Overrides:
setBaseStyle in class StatefulCanvas
Parameters:
baseStyle - new base style. Default value is "imgButton"

getBaseStyle

public String getBaseStyle()
Base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.

When the component changes state (eg becomes disabled), a suffix will be appended to this style name, reflecting the following states: "Over", "Down", or "Disabled".

If the widget is selected, the suffixes will be "Selected", "SelectedOver", etc.

If the widget has focus and showFocused is true, and showFocusedAsOver is false, the suffixes will be "Focused", "FocusedOver", etc, or if the widget is both selected and focused, "SelectedFocused", "SelectedFocusedOver", etc.

For example, if baseStyle is set to "button", this component is isSelected() and the mouse cursor is over this component, the style "buttonSelectedOver" will be used.

Overrides:
getBaseStyle in class StatefulCanvas
Returns:
String

setSelected

public void setSelected(Boolean selected)
Whether this component is selected. For some components, selection affects appearance. Select this object.

Overrides:
setSelected in class StatefulCanvas
Parameters:
selected - selected Default value is false

getSelected

public Boolean getSelected()
Whether this component is selected. For some components, selection affects appearance.

Overrides:
getSelected in class StatefulCanvas
Returns:
Boolean

setRadioGroup

public void setRadioGroup(String radioGroup)
String identifier for this canvas's mutually exclusive selection group.

Note : This is an advanced setting

Overrides:
setRadioGroup in class StatefulCanvas
Parameters:
radioGroup - radioGroup Default value is null

getRadioGroup

public String getRadioGroup()
String identifier for this canvas's mutually exclusive selection group.

Overrides:
getRadioGroup in class StatefulCanvas
Returns:
String

setActionType

public void setActionType(SelectionType actionType)
Behavior on state changes -- BUTTON, RADIO or CHECKBOX Update the 'actionType' for this canvas (radio / checkbox / button) If the canvas is currently selected, and the passed in actionType is 'button' this method will deselect the canvas.

Overrides:
setActionType in class StatefulCanvas
Parameters:
actionType - actionType Default value is "button"

getActionType

public SelectionType getActionType()
Behavior on state changes -- BUTTON, RADIO or CHECKBOX

Overrides:
getActionType in class StatefulCanvas
Returns:
Return the 'actionType' for this canvas (radio / checkbox / button)

setState

public void setState(State state)
Current "state" of this widget. StatefulCanvases will have a different appearance based on their current state. By default this is handled by changing the css className applied to the StatefulCanvas - see baseStyle for a description of how this is done.

For Img or StretchImg based subclasses of StatefulCanvas, the appearance may also be updated by changing the src of the rendered image. See src and src for a description of how the URL is modified to reflect the state of the widget in this case. Set the 'state' of this object, this changes it's appearance.

Note : This is an advanced setting

Overrides:
setState in class StatefulCanvas
Parameters:
state - new state. Default value is ""

getState

public State getState()
Current "state" of this widget. StatefulCanvases will have a different appearance based on their current state. By default this is handled by changing the css className applied to the StatefulCanvas - see baseStyle for a description of how this is done.

For Img or StretchImg based subclasses of StatefulCanvas, the appearance may also be updated by changing the src of the rendered image. See src and src for a description of how the URL is modified to reflect the state of the widget in this case.

Overrides:
getState in class StatefulCanvas
Returns:
Return the state of this StatefulCanvas

setShowDisabled

public void setShowDisabled(Boolean showDisabled)
Should we visibly change state when disabled?

Overrides:
setShowDisabled in class StatefulCanvas
Parameters:
showDisabled - showDisabled Default value is true

getShowDisabled

public Boolean getShowDisabled()
Should we visibly change state when disabled?

Overrides:
getShowDisabled in class StatefulCanvas
Returns:
Boolean

setShowDown

public void setShowDown(Boolean showDown)
Should we visibly change state when the mouse goes down in this object?

Overrides:
setShowDown in class StatefulCanvas
Parameters:
showDown - showDown Default value is false

getShowDown

public Boolean getShowDown()
Should we visibly change state when the mouse goes down in this object?

Overrides:
getShowDown in class StatefulCanvas
Returns:
Boolean

setShowFocused

public void setShowFocused(Boolean showFocused)
Should we visibly change state when the canvas recieves focus? If showFocusedAsOver is true, the "over" will be used to indicate focus. Otherwise a separate "focused" state will be used.

Overrides:
setShowFocused in class StatefulCanvas
Parameters:
showFocused - showFocused Default value is false

getShowFocused

public Boolean getShowFocused()
Should we visibly change state when the canvas recieves focus? If showFocusedAsOver is true, the "over" will be used to indicate focus. Otherwise a separate "focused" state will be used.

Overrides:
getShowFocused in class StatefulCanvas
Returns:
Boolean

setShowRollOver

public void setShowRollOver(Boolean showRollOver)
Should we visibly change state when the mouse goes over this object?

Overrides:
setShowRollOver in class StatefulCanvas
Parameters:
showRollOver - showRollOver Default value is false

getShowRollOver

public Boolean getShowRollOver()
Should we visibly change state when the mouse goes over this object?

Overrides:
getShowRollOver in class StatefulCanvas
Returns:
Boolean

setAlign

public void setAlign(Alignment align)
Horizontal alignment of this component's title.

Overrides:
setAlign in class StatefulCanvas
Parameters:
align - align Default value is Canvas.CENTER

getAlign

public Alignment getAlign()
Horizontal alignment of this component's title.

Overrides:
getAlign in class StatefulCanvas
Returns:
Alignment

setValign

public void setValign(VerticalAlignment valign)
Vertical alignment of this component's title.

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

getValign

public VerticalAlignment getValign()
Vertical alignment of this component's title.

Overrides:
getValign in class StatefulCanvas
Returns:
VerticalAlignment

setShowTitle

public void setShowTitle(Boolean showTitle)
Determines whether any specified StatefulCanvas.getTitle() will be displayed for this component.
Applies to Image-based components only, where the title will be rendered out in a label floating over the component

Note : This is an advanced setting

Overrides:
setShowTitle in class Img
Parameters:
showTitle - showTitle Default value is false

getShowTitle

public Boolean getShowTitle()
Determines whether any specified StatefulCanvas.getTitle() will be displayed for this component.
Applies to Image-based components only, where the title will be rendered out in a label floating over the component

Overrides:
getShowTitle in class Img
Returns:
Boolean

setLabelHPad

public void setLabelHPad(Integer labelHPad)
Horizontal padding to be applied to this widget's label. If this value is null, the label will be given a horizontal padding of zero.

The specified amount of padding is applied to the left and right edges of the button, so the total amount of padding is 2x the specified value.

Parameters:
labelHPad - labelHPad Default value is null

getLabelHPad

public Integer getLabelHPad()
Horizontal padding to be applied to this widget's label. If this value is null, the label will be given a horizontal padding of zero.

The specified amount of padding is applied to the left and right edges of the button, so the total amount of padding is 2x the specified value.

Returns:
Integer

setLabelVPad

public void setLabelVPad(Integer labelVPad)
Vertical padding to be applied to this widget's label. If this value is null, the label will be given a vertial padding of zero.

The specified amount of padding is applied to the top and bottom edges of the button, so the total amount of padding is 2x the specified value.

Parameters:
labelVPad - labelVPad Default value is null

getLabelVPad

public Integer getLabelVPad()
Vertical padding to be applied to this widget's label. If this value is null, the label will be given a vertial padding of zero.

The specified amount of padding is applied to the top and bottom edges of the button, so the total amount of padding is 2x the specified value.

Returns:
Integer

setSrc

public void setSrc(String src)
The base filename for the image.

If img.state is set, it's value will be appended to the URL before the file extension.

For example, given an src of "findIcon.gif" and a state of "Disabled", the resulting image name would be "findIcon_Disabled.gif". Compound states such as "Selected", "Focused" and "Over" or "Down" will have an intervening underscore, resulting in, for example, "findIcon_Selected_Down.gif".

Overrides:
setSrc in class Img
Parameters:
src - src Default value is "[SKIN]/ImgButton/button.png"

getSrc

public String getSrc()
The base filename for the image.

If img.state is set, it's value will be appended to the URL before the file extension.

For example, given an src of "findIcon.gif" and a state of "Disabled", the resulting image name would be "findIcon_Disabled.gif". Compound states such as "Selected", "Focused" and "Over" or "Down" will have an intervening underscore, resulting in, for example, "findIcon_Selected_Down.gif".

Overrides:
getSrc in class Img
Returns:
String

select

public void select()
Select this object.

Overrides:
select in class StatefulCanvas

deselect

public void deselect()
Select this object.

Overrides:
deselect in class StatefulCanvas

isSelected

public Boolean isSelected()
Find out if this object is selected

Overrides:
isSelected in class StatefulCanvas
Returns:

addToRadioGroup

public void addToRadioGroup(String groupID)
Add this widget to the specified mutually exclusive selection group with the ID passed in. Selecting this widget will then deselect any other StatefulCanvases with the same radioGroup ID. StatefulCanvases can belong to only one radioGroup, so this method will remove from any other radiogroup of which this button is already a member.

Overrides:
addToRadioGroup in class StatefulCanvas
Parameters:
groupID - - ID of the radiogroup to which this widget should be added

removeFromRadioGroup

public void removeFromRadioGroup()
Remove this widget from the specified mutually exclusive selection group with the ID passed in. No-op's if this widget is not a member of the groupID passed in. If no groupID is passed in, defaults to removing from whatever radioGroup this widget is a member of.

Overrides:
removeFromRadioGroup in class StatefulCanvas

removeFromRadioGroup

public void removeFromRadioGroup(String groupID)
Remove this widget from the specified mutually exclusive selection group with the ID passed in. No-op's if this widget is not a member of the groupID passed in. If no groupID is passed in, defaults to removing from whatever radioGroup this widget is a member of.

Overrides:
removeFromRadioGroup in class StatefulCanvas
Parameters:
groupID - - optional radio group ID (to ensure the widget is removed from the appropriate group.

setDisabled

public void setDisabled(boolean disabled)
Enable or disable this object

Overrides:
setDisabled in class StatefulCanvas
Parameters:
disabled - true if this widget is to be disabled

action

public void action()
This property contains the default 'action' for the Button to fire when activated.