public class StretchImgButton extends StretchImg implements HasIconClickHandlers, HasTitleHoverHandlers
overflow
is set to
"visible". Examples of use include fancy buttons, poplist headers, and tabs.
config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName
Constructor and Description |
---|
StretchImgButton() |
StretchImgButton(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
void |
action()
This property contains the default 'action' for the Button to fire when activated.
|
com.google.gwt.event.shared.HandlerRegistration |
addIconClickHandler(IconClickHandler handler)
Add a iconClick handler.
|
com.google.gwt.event.shared.HandlerRegistration |
addTitleHoverHandler(TitleHoverHandler handler)
Add a titleHover handler.
|
void |
addToRadioGroup(java.lang.String groupID)
Add this widget to the specified mutually exclusive selection group with the ID passed in.
|
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() |
void |
deselect()
Select this object.
|
SelectionType |
getActionType()
Behavior on state changes -- BUTTON, RADIO or CHECKBOX
|
Alignment |
getAlign()
Horizontal alignment of this component's title.
|
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 |
getBaseStyle()
Base CSS style className applied to the component.
|
int |
getCapSize()
How big are the end pieces by default
|
java.lang.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. |
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.
|
java.lang.Integer |
getLabelBreadthPad()
The padding for a StretchImgButton's label is determined as follows.
|
java.lang.Integer |
getLabelHPad()
The padding for a StretchImgButton's label is determined as follows.
|
java.lang.Integer |
getLabelLengthPad()
The padding for a StretchImgButton's label is determined as follows.
|
java.lang.String |
getLabelSkinImgDir()
Specifies a skinImgDir to apply to the label containing the title of this StretchImgButton.
|
java.lang.Integer |
getLabelVPad()
The padding for a StretchImgButton's label is determined as follows.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
getLogicalStructure()
Getter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
static StretchImgButton |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getRadioGroup()
String identifier for this canvas's mutually exclusive selection group.
|
java.lang.Boolean |
getSelected()
Whether this component is selected.
|
java.lang.Boolean |
getShowClippedTitleOnHover()
If true and the title is clipped, then a hover containing the full title of this button is enabled.
|
java.lang.Boolean |
getShowDisabled()
Should we visibly change state when disabled?
|
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 |
getShowDown()
Should we visibly change state when the mouse goes down in this object?
|
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 |
getShowFocused()
Should we visibly change state when the canvas receives focus? If
StatefulCanvas.showFocusedAsOver is true ,
then "over" will be used to indicate focus. |
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 |
getShowRollOver()
Should we visibly change state when the mouse goes over this object?
|
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.Boolean |
getShowTitle()
Determines whether any specified
title 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 |
java.lang.String |
getSrc()
Base URL for the image.
|
State |
getState()
Current "state" of this widget.
|
java.lang.String |
getTitle()
The title HTML to display in this button.
|
java.lang.String |
getTitleStyle()
CSS style applied to the title text only.
|
VerticalAlignment |
getValign()
Vertical alignment of this component's title.
|
java.lang.Boolean |
getVertical()
Default is a horizontal button.
|
java.lang.Boolean |
getWrap()
Should the title for this button wrap? If unset, default behavior is to allow wrapping if this.vertical is true,
otherwise disallow wrapping
|
java.lang.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(java.lang.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
If this method is called after the component has been drawn/initialized: 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(java.lang.Boolean autoFit)
If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
|
void |
setBaseStyle(java.lang.String baseStyle)
Base CSS style className applied to the component.
|
void |
setCapSize(int capSize)
How big are the end pieces by default
|
static void |
setDefaultProperties(StretchImgButton stretchImgButtonProperties)
Class level method to set the default properties of this class.
|
void |
setHiliteAccessKey(java.lang.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(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 |
setLabelBreadthPad(java.lang.Integer labelBreadthPad)
The padding for a StretchImgButton's label is determined as follows.
|
void |
setLabelHPad(java.lang.Integer labelHPad)
The padding for a StretchImgButton's label is determined as follows.
|
void |
setLabelLengthPad(java.lang.Integer labelLengthPad)
The padding for a StretchImgButton's label is determined as follows.
|
void |
setLabelSkinImgDir(java.lang.String labelSkinImgDir)
Specifies a skinImgDir to apply to the label containing the title of this StretchImgButton.
|
void |
setLabelVPad(java.lang.Integer labelVPad)
The padding for a StretchImgButton's label is determined as follows.
|
com.smartgwt.logicalstructure.core.LogicalStructureObject |
setLogicalStructure(com.smartgwt.logicalstructure.widgets.StretchImgButtonLogicalStructure s)
Setter implementing the
LogicalStructure interface,
which supports Eclipse's logical structure debugging facility. |
void |
setRadioGroup(java.lang.String radioGroup)
String identifier for this canvas's mutually exclusive selection group.
|
void |
setSelected(java.lang.Boolean selected)
Whether this component is selected.
|
void |
setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)
If true and the title is clipped, then a hover containing the full title of this button is enabled.
|
void |
setShowDisabled(java.lang.Boolean showDisabled)
Should we visibly change state when disabled?
|
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 |
setShowDown(java.lang.Boolean showDown)
Should we visibly change state when the mouse goes down in this object?
|
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 |
setShowFocused(java.lang.Boolean showFocused)
Should we visibly change state when the canvas receives focus? If
StatefulCanvas.showFocusedAsOver is true ,
then "over" will be used to indicate focus. |
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 |
setShowRollOver(java.lang.Boolean showRollOver)
Should we visibly change state when the mouse goes over this object?
|
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 |
setShowTitle(java.lang.Boolean showTitle)
Determines whether any specified
title 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(java.lang.String src)
Base URL for the image.
|
void |
setState(State state)
Current "state" of this widget.
|
void |
setTitle(java.lang.String title)
The title HTML to display in this button.
|
void |
setTitleHoverFormatter(TitleHoverFormatter formatter)
Provide a custom implementation of
titleHoverHTML(java.lang.String) . |
void |
setTitleStyle(java.lang.String titleStyle)
CSS style applied to the title text only.
|
void |
setValign(VerticalAlignment valign)
Vertical alignment of this component's title.
|
void |
setVertical(java.lang.Boolean vertical)
Default is a horizontal button.
|
void |
setWrap(java.lang.Boolean wrap)
Should the title for this button wrap? If unset, default behavior is to allow wrapping if this.vertical is true,
otherwise disallow wrapping
|
boolean |
titleClipped()
Is the title of this button clipped?
|
java.lang.String |
titleHoverHTML(java.lang.String defaultHTML)
Returns the HTML that is displayed by the default
titleHover handler. |
getGripImgSuffix, getHSrc, getIgnoreRTL, getImageType, getItemBaseStyle, getItems, getShowDownGrip, getShowGrip, getShowRollOverGrip, getVSrc, setDefaultProperties, setGripImgSuffix, setHSrc, setIgnoreRTL, setImageType, setItemBaseStyle, setItems, setLogicalStructure, setShowDownGrip, setShowGrip, setShowRollOverGrip, setState, setState, setVSrc
getEditProxyConstructor, getIconStyle, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getShowFocusedAsOver, getShowOverCanvas, getShowRTLIcon, getStateSuffix, setDefaultProperties, setEditProxyConstructor, setIconStyle, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setShowFocusedAsOver, setShowOverCanvas, setShowRTLIcon
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, 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, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoMaskComponents, getAutoParent, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, 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, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, 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, getRuleContext, getRuleContext, getRuleScope, 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, getStyleName, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, 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, provideRuleContext, redraw, redraw, removeChild, removeChild, removePeer, removePeer, removeSnapAlignCandidate, resizeBy, resizeControls, resizeFonts, resizeFonts, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, 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, setAutoParent, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, 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, setIsRuleScope, 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, setRuleScope, 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, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
addDrawHandler, applyFactoryProperties, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getById, getByJSObject, 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, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toString
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent
public StretchImgButton()
public StretchImgButton(com.google.gwt.core.client.JavaScriptObject jsObj)
public static StretchImgButton 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
.AutoChildUsage
public 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
.AutoChildUsage
protected com.google.gwt.core.client.JavaScriptObject create()
create
in class StretchImg
public void setActionType(SelectionType actionType)
setActionType
in class StatefulCanvas
actionType
- Default value is "button"State overview and related methods
public SelectionType getActionType()
getActionType
in class StatefulCanvas
State overview and related methods
public void setAlign(Alignment align)
setAlign
in class StatefulCanvas
align
- Default value is Canvas.CENTERAppearance overview and related methods
public Alignment getAlign()
getAlign
in class StatefulCanvas
Appearance overview and related methods
public 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"
If this method is called after the component has been drawn/initialized:
Setter method for the StatefulCanvas.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.
setAutoFit
in class StatefulCanvas
autoFit
- New autoFit setting.. Default value is nullSizing overview and related methods
public 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 StatefulCanvas
Sizing overview and related methods
public void setBaseStyle(java.lang.String baseStyle)
As the component changes StatefulCanvas.state
and/or is selected, suffixes will be added to
the base style. In some cases more than one suffix will be appended to reflect a combined state ("Selected" +
"Disabled", for example).
See StatefulCanvas.getStateSuffix()
for a description of the default set of suffixes which may be applied to the baseStyle
If this method is called after the component has been drawn/initialized:
Sets the base CSS style. As the component changes state and/or is selected, suffixes will be added to the base style.
setBaseStyle
in class StatefulCanvas
baseStyle
- new base styleCSSStyleName . Default value is "stretchImgButton"
public java.lang.String getBaseStyle()
As the component changes StatefulCanvas.state
and/or is selected, suffixes will be added to
the base style. In some cases more than one suffix will be appended to reflect a combined state ("Selected" +
"Disabled", for example).
See StatefulCanvas.getStateSuffix()
for a description of the default set of suffixes which may be applied to the baseStyle
getBaseStyle
in class StatefulCanvas
CSSStyleName
public void setCapSize(int capSize)
setCapSize
in class StretchImg
capSize
- Default value is 12Appearance overview and related methods
public int getCapSize()
getCapSize
in class StretchImg
Appearance overview and related methods
public void setHiliteAccessKey(java.lang.Boolean hiliteAccessKey)
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.hiliteAccessKey
- Default value is truepublic java.lang.Boolean getHiliteAccessKey()
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.public void setIcon(java.lang.String icon)
Specify as the partial URL to an image, relative to the imgDir of this component.
Note that the string "blank" is a valid setting for this attribute and will always result
in the system blank image, without applying state suffixes. Typically, this might be used when an iconStyle is also
specified and the iconStyle renders the icon via a stateful background-image or other CSS approach.
If this method is called after the component has been drawn/initialized:
Change the icon being shown next to the title text.
setIcon
in class StatefulCanvas
icon
- URL of new iconSCImgURL . Default value is null
,
ButtonIcon overview and related methods
public java.lang.String getIcon()
Specify as the partial URL to an image, relative to the imgDir of this component.
Note that the string "blank" is a valid setting for this attribute and will always result in the system blank image, without applying state suffixes. Typically, this might be used when an iconStyle is also specified and the iconStyle renders the icon via a stateful background-image or other CSS approach.
getIcon
in class StatefulCanvas
SCImgURL
,
ButtonIcon overview and related methods
public void setIconAlign(java.lang.String iconAlign) throws java.lang.IllegalStateException
iconAlign
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public java.lang.String getIconAlign()
ButtonIcon overview and related methods
public void setIconHeight(java.lang.Integer iconHeight) throws java.lang.IllegalStateException
If unset, defaults to iconSize
.
setIconHeight
in class StatefulCanvas
iconHeight
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public java.lang.Integer getIconHeight()
If unset, defaults to iconSize
.
getIconHeight
in class StatefulCanvas
ButtonIcon overview and related methods
public void setIconOrientation(java.lang.String iconOrientation) throws java.lang.IllegalStateException
"left"
and "right"
.
setIconOrientation
in class StatefulCanvas
iconOrientation
- 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 methods
public java.lang.String getIconOrientation()
"left"
and "right"
.getIconOrientation
in class StatefulCanvas
ButtonIcon overview and related methods
public 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 StatefulCanvas
iconSize
- Default value is 16java.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public 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 StatefulCanvas
ButtonIcon overview and related methods
public 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 methods
public int getIconSpacing()
ButtonIcon overview and related methods
public void setIconWidth(java.lang.Integer iconWidth) throws java.lang.IllegalStateException
If unset, defaults to iconSize
.
setIconWidth
in class StatefulCanvas
iconWidth
- Default value is nulljava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public java.lang.Integer getIconWidth()
If unset, defaults to iconSize
.
getIconWidth
in class StatefulCanvas
ButtonIcon overview and related methods
public void setLabelBreadthPad(java.lang.Integer labelBreadthPad)
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
labelBreadthPad
- Default value is nullpublic java.lang.Integer getLabelBreadthPad()
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
public void setLabelHPad(java.lang.Integer labelHPad)
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
labelHPad
- Default value is nullpublic java.lang.Integer getLabelHPad()
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
public void setLabelLengthPad(java.lang.Integer labelLengthPad)
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
labelLengthPad
- Default value is nullpublic java.lang.Integer getLabelLengthPad()
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
public void setLabelSkinImgDir(java.lang.String labelSkinImgDir)
this.skinImgDir
will be applied to the label as well. Note that icons displayed in the title may make
use of the skin img dir set here
If this method is called after the component has been drawn/initialized:
setter for labelSkinImgDir
.
Note : This is an advanced setting
labelSkinImgDir
- new skin img dir to apply to the label holding title text for this widget.. Default value is nullpublic java.lang.String getLabelSkinImgDir()
this.skinImgDir
will be applied to the label as well. Note that icons displayed in the title may make use of the skin img dir set here
public void setLabelVPad(java.lang.Integer labelVPad)
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
labelVPad
- Default value is nullpublic java.lang.Integer getLabelVPad()
If labelHPad
is set it will
specify the horizontal padding applied to the label. Similarly if labelVPad
is set it will specify the
vertical padding for the label, regardless of the button's vertical
setting.
Otherwise labelLengthPad
can be set to specify the label padding along the length axis (ie: horizontal padding if vertical
is false, otherwise vertical padding), and
labelBreadthPad
can be set to specify the label padding along the other axis.
Otherwise the padding on
the length axis will match the capSize
and will be set
to zero on the breadth axis.
So by default the label will be sized to match the center image of the StretchImgButton, but these settings allow the label to partially or wholly overlap the caps.
public void setRadioGroup(java.lang.String radioGroup)
Note : This is an advanced setting
setRadioGroup
in class StatefulCanvas
radioGroup
- Default value is nullState overview and related methods
public java.lang.String getRadioGroup()
getRadioGroup
in class StatefulCanvas
State overview and related methods
public void setSelected(java.lang.Boolean selected)
setSelected
in class StatefulCanvas
selected
- Default value is falseState overview and related methods
public java.lang.Boolean getSelected()
getSelected
in class StatefulCanvas
State overview and related methods
public void setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)
showClippedTitleOnHover
- Default value is falsepublic java.lang.Boolean getShowClippedTitleOnHover()
public void setShowDisabled(java.lang.Boolean showDisabled)
setShowDisabled
in class StatefulCanvas
showDisabled
- Default value is trueState overview and related methods
public java.lang.Boolean getShowDisabled()
getShowDisabled
in class StatefulCanvas
State overview and related methods
public void setShowDisabledIcon(java.lang.Boolean showDisabledIcon) throws java.lang.IllegalStateException
setShowDisabledIcon
in class StatefulCanvas
showDisabledIcon
- Default value is truejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public java.lang.Boolean getShowDisabledIcon()
getShowDisabledIcon
in class StatefulCanvas
ButtonIcon overview and related methods
public void setShowDown(java.lang.Boolean showDown)
setShowDown
in class StatefulCanvas
showDown
- Default value is falseState overview and related methods
public java.lang.Boolean getShowDown()
getShowDown
in class StatefulCanvas
State overview and related methods
public void setShowDownIcon(java.lang.Boolean showDownIcon) throws java.lang.IllegalStateException
setShowDownIcon
in class StatefulCanvas
showDownIcon
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public java.lang.Boolean getShowDownIcon()
getShowDownIcon
in class StatefulCanvas
ButtonIcon overview and related methods
public void setShowFocused(java.lang.Boolean showFocused)
StatefulCanvas.showFocusedAsOver
is true
,
then "over"
will be used to indicate focus. Otherwise a separate "focused"
state
will be used.setShowFocused
in class StatefulCanvas
showFocused
- Default value is falseState overview and related methods
public java.lang.Boolean getShowFocused()
StatefulCanvas.showFocusedAsOver
is true
,
then "over"
will be used to indicate focus. Otherwise a separate "focused"
state
will be used.getShowFocused
in class StatefulCanvas
State overview and related methods
public 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 StatefulCanvas
showFocusedIcon
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public 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 StatefulCanvas
ButtonIcon overview and related methods
public void setShowRollOver(java.lang.Boolean showRollOver)
setShowRollOver
in class StatefulCanvas
showRollOver
- Default value is falseState overview and related methods
public java.lang.Boolean getShowRollOver()
getShowRollOver
in class StatefulCanvas
State overview and related methods
public void setShowRollOverIcon(java.lang.Boolean showRollOverIcon) throws java.lang.IllegalStateException
setShowRollOverIcon
in class StatefulCanvas
showRollOverIcon
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public java.lang.Boolean getShowRollOverIcon()
getShowRollOverIcon
in class StatefulCanvas
ButtonIcon overview and related methods
public void setShowSelectedIcon(java.lang.Boolean showSelectedIcon) throws java.lang.IllegalStateException
setShowSelectedIcon
in class StatefulCanvas
showSelectedIcon
- Default value is falsejava.lang.IllegalStateException
- this property cannot be changed after the component has been createdButtonIcon overview and related methods
public java.lang.Boolean getShowSelectedIcon()
getShowSelectedIcon
in class StatefulCanvas
ButtonIcon overview and related methods
public void setShowTitle(java.lang.Boolean showTitle)
title
will be displayed
for this component.setShowTitle
in class StretchImg
showTitle
- Default value is truepublic java.lang.Boolean getShowTitle()
title
will be displayed
for this component.getShowTitle
in class StretchImg
public void setSrc(java.lang.String src)
The images displayed in the stretchImgButton are derived from this property in the following way:
this.capSize
by the
specified width of the stretchImgButton), "button_stretch.gif" (stretched to the necessary width) and
"button_end.gif" (sized the same as the start image). Img.src
for an overview of how states are combined into a compound URL.
"button_Selected_Down_stretch.gif"
. Media should be present for each possible state of the _start, _end and _stretch images.
setSrc
in class StretchImg
src
- SCImgURL . Default value is "button.gif"
public java.lang.String getSrc()
The images displayed in the stretchImgButton are derived from this property in the following way:
this.capSize
by the
specified width of the stretchImgButton), "button_stretch.gif" (stretched to the necessary width) and
"button_end.gif" (sized the same as the start image). Img.src
for an overview of how states are combined into a compound URL.
"button_Selected_Down_stretch.gif"
. Media should be present for each possible state of the _start, _end and _stretch images.
getSrc
in class StretchImg
SCImgURL
public void setState(State state)
StatefulCanvas.showRollOver
, StatefulCanvas.showDown
, StatefulCanvas.showDisabled
). 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 StatefulCanvas.baseStyle
and
StatefulCanvas.getStateSuffix()
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
Img.src
and src
for a description of how the URL is modified to reflect the state of the widget in this case.
If this method is called after the component has been drawn/initialized:
Sets the state
of this object, changing its appearance. Note: newState
cannot be State.STATE_DISABLED
if this.showDisabled
is false
.
Note : This is an advanced setting
setState
in class StatefulCanvas
state
- the new state.. Default value is ""State
,
State overview and related methods
public State getState()
StatefulCanvas.showRollOver
, StatefulCanvas.showDown
, StatefulCanvas.showDisabled
). 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 StatefulCanvas.baseStyle
and
StatefulCanvas.getStateSuffix()
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
Img.src
and src
for a description of how the URL is modified to reflect the state of the widget in this case.
getState
in class StatefulCanvas
State
,
State overview and related methods
public void setTitle(java.lang.String title)
title
.setTitle
in class StatefulCanvas
title
- the new title HTML.HTMLString . Default value is null
,
Basics overview and related methods
public java.lang.String getTitle()
getTitle
in class StatefulCanvas
Default is to simply return this.title.
HTMLString
,
Basics overview and related methods
public void setTitleStyle(java.lang.String titleStyle)
baseStyle
when unset. With a separate titleStyle
and baseStyle
set, you can provide a backgroundColor via
baseStyle
that will allow translucent .png media to be "tinted" by the underlying background color, so that
a single set of media can provide range of color options. In this usage, the titleStyle
should generally
not specify a background color as this would block out the media that appears behind the title.
If this method is called after the component has been drawn/initialized:
Sets the titleStyle
, which is applied to the title text.
setTitleStyle
in class StatefulCanvas
titleStyle
- new title styleCSSStyleName . Default value is null
public java.lang.String getTitleStyle()
baseStyle
when unset. With a separate titleStyle
and baseStyle
set, you can provide a backgroundColor via
baseStyle
that will allow translucent .png media to be "tinted" by the underlying background color, so that
a single set of media can provide range of color options. In this usage, the titleStyle
should generally
not specify a background color as this would block out the media that appears behind the title.
CSSStyleName
public void setValign(VerticalAlignment valign)
setValign
in class StatefulCanvas
valign
- Default value is Canvas.CENTERAppearance overview and related methods
public VerticalAlignment getValign()
getValign
in class StatefulCanvas
Appearance overview and related methods
public void setVertical(java.lang.Boolean vertical)
setVertical
in class StretchImg
vertical
- Default value is falseAppearance overview and related methods
public java.lang.Boolean getVertical()
getVertical
in class StretchImg
Appearance overview and related methods
public void setWrap(java.lang.Boolean wrap)
wrap
- Default value is nullpublic java.lang.Boolean getWrap()
public void action()
public void addToRadioGroup(java.lang.String groupID)
addToRadioGroup
in class StatefulCanvas
groupID
- - ID of the radiogroup to which this widget should be addedState overview and related methods
public void deselect()
deselect
in class StatefulCanvas
State overview and related methods
public com.google.gwt.event.shared.HandlerRegistration addIconClickHandler(IconClickHandler handler)
If this button is showing an icon
, a separate click handler
for the icon may be defined as this.iconClick
. Returning false will suppress the standard button click
handling code.
addIconClickHandler
in interface HasIconClickHandlers
handler
- the iconClick handlerHandlerRegistration
used to remove this handlerpublic java.lang.Boolean isSelected()
isSelected
in class StatefulCanvas
State overview and related methods
public void removeFromRadioGroup()
removeFromRadioGroup
in class StatefulCanvas
State overview and related methods
public void removeFromRadioGroup(java.lang.String groupID)
removeFromRadioGroup
in class StatefulCanvas
groupID
- - optional radio group ID (to ensure the widget is removed from the appropriate
group.State overview and related methods
public void select()
select
in class StatefulCanvas
State overview and related methods
public boolean titleClipped()
public com.google.gwt.event.shared.HandlerRegistration addTitleHoverHandler(TitleHoverHandler handler)
Optional stringMethod to fire when the user hovers over this button and the title is clipped. If StretchImgButton.showClippedTitleOnHover
is
true, the default behavior is to show a hover canvas containing the HTML returned by StretchImgButton.titleHoverHTML()
. Call TitleHoverEvent.cancel()
from within TitleHoverHandler.onTitleHover(com.smartgwt.client.widgets.events.TitleHoverEvent)
to suppress this default behavior.
addTitleHoverHandler
in interface HasTitleHoverHandlers
handler
- the titleHover handlerHandlerRegistration
used to remove this handlerpublic java.lang.String titleHoverHTML(java.lang.String defaultHTML)
titleHover
handler. Return null or an empty string to
cancel the hover. Use setTitleHoverFormatter()
to provide a custom implementation.
defaultHTML
- the HTML that would have been displayed by default. See HTMLString
public static void setDefaultProperties(StretchImgButton stretchImgButtonProperties)
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.
stretchImgButtonProperties
- properties that should be used as new defaults when instances of this class are createdSGWTProperties
public void setTitleHoverFormatter(TitleHoverFormatter formatter)
titleHoverHTML(java.lang.String)
.public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.StretchImgButtonLogicalStructure 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 LogicalStructure
getLogicalStructure
in class StretchImg