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.Integer |
getHeight()
Size for this component's vertical dimension.
|
java.lang.String |
getHeightAsString()
Size for this component's vertical dimension.
|
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 |
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.Integer |
getWidth()
Size for this component's horizontal dimension.
|
java.lang.String |
getWidthAsString()
Size for this component's horizontal dimension.
|
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
|
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.
|
StretchImgButton |
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. |
StretchImgButton |
setAlign(Alignment align)
Horizontal alignment of this component's title.
|
StretchImgButton |
setAutoFit(java.lang.Boolean autoFit)
If true, ignore the specified size of this widget and always size just large enough to accommodate the title.
|
StretchImgButton |
setBaseStyle(java.lang.String baseStyle)
Base CSS style className applied to the component.
|
StretchImgButton |
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.
|
StretchImgButton |
setHeight(java.lang.Integer height)
Size for this component's vertical dimension.
|
void |
setHeight(java.lang.String height)
Size for this component's vertical dimension.
|
StretchImgButton |
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. |
StretchImgButton |
setIcon(java.lang.String icon)
Optional icon to be shown with the button title text.
|
StretchImgButton |
setIconAlign(java.lang.String iconAlign)
If this button is showing an icon should it be right or left aligned?
|
StretchImgButton |
setIconHeight(java.lang.Integer iconHeight)
Height in pixels of the icon image.
|
StretchImgButton |
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". |
StretchImgButton |
setIconSize(int iconSize)
Size in pixels of the icon image.
|
StretchImgButton |
setIconSpacing(int iconSpacing)
Pixels between icon and title text.
|
StretchImgButton |
setIconWidth(java.lang.Integer iconWidth)
Width in pixels of the icon image.
|
StretchImgButton |
setLabelBreadthPad(java.lang.Integer labelBreadthPad)
The padding for a StretchImgButton's label is determined as follows.
|
StretchImgButton |
setLabelHPad(java.lang.Integer labelHPad)
The padding for a StretchImgButton's label is determined as follows.
|
StretchImgButton |
setLabelLengthPad(java.lang.Integer labelLengthPad)
The padding for a StretchImgButton's label is determined as follows.
|
StretchImgButton |
setLabelSkinImgDir(java.lang.String labelSkinImgDir)
Specifies a skinImgDir to apply to the label containing the title of this StretchImgButton.
|
StretchImgButton |
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. |
StretchImgButton |
setRadioGroup(java.lang.String radioGroup)
String identifier for this canvas's mutually exclusive selection group.
|
StretchImgButton |
setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)
If true and the title is clipped, then a hover containing the full title of this button is enabled.
|
StretchImgButton |
setShowDisabled(java.lang.Boolean showDisabled)
Should we visibly change state when disabled?
|
StretchImgButton |
setShowDisabledIcon(java.lang.Boolean showDisabledIcon)
If using an icon for this button, whether to switch the icon image if the button becomes disabled.
|
StretchImgButton |
setShowDown(java.lang.Boolean showDown)
Should we visibly change state when the mouse goes down in this object?
|
StretchImgButton |
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.
|
StretchImgButton |
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. |
StretchImgButton |
setShowFocusedIcon(java.lang.Boolean showFocusedIcon)
If using an icon for this button, whether to switch the icon image when the button receives focus.
|
StretchImgButton |
setShowRollOver(java.lang.Boolean showRollOver)
Should we visibly change state when the mouse goes over this object?
|
StretchImgButton |
setShowRollOverIcon(java.lang.Boolean showRollOverIcon)
If using an icon for this button, whether to switch the icon image on mouse rollover.
|
StretchImgButton |
setShowSelectedIcon(java.lang.Boolean showSelectedIcon)
If using an icon for this button, whether to switch the icon image when the button becomes selected.
|
StretchImgButton |
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 |
StretchImgButton |
setSrc(java.lang.String src)
Base URL for the image.
|
StretchImgButton |
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). |
StretchImgButton |
setTitleStyle(java.lang.String titleStyle)
CSS style applied to the title text only.
|
StretchImgButton |
setValign(VerticalAlignment valign)
Vertical alignment of this component's title.
|
StretchImgButton |
setVertical(java.lang.Boolean vertical)
Default is a horizontal button.
|
StretchImgButton |
setWidth(java.lang.Integer width)
Size for this component's horizontal dimension.
|
void |
setWidth(java.lang.String width)
Size for this component's horizontal dimension.
|
StretchImgButton |
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, setVSrcgetAriaLabel, getAriaStateDefaults, getEditProxyConstructor, getIconStyle, getOverCanvas, getOverCanvasConstructor, getRedrawOnStateChange, getSelected, getShowFocusedAsOver, getShowMenuOnClick, getShowOverCanvas, getShowRTLIcon, getStateSuffix, getStyleName, isSelected, setAriaLabel, setDefaultProperties, setEditProxyConstructor, setIconStyle, setLogicalStructure, setOverCanvasConstructor, setRedrawOnStateChange, setSelected, setShowFocusedAsOver, setShowMenuOnClick, setShowOverCanvas, setShowRTLIcon, setStyleName, setTitleFormatteraddChild, addChild, addChild, addChild, addChild, addClearHandler, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getTabIndex, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setTabIndex, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropaddDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringaddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsaddStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventpublic 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.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsageprotected com.google.gwt.core.client.JavaScriptObject create()
create in class StretchImgpublic StretchImgButton setActionType(SelectionType actionType)
setActionType in class StatefulCanvasactionType - New actionType value. Default value is "button"StretchImgButton instance, for chaining setter callsState overview and related methodspublic SelectionType getActionType()
getActionType in class StatefulCanvasState overview and related methodspublic StretchImgButton setAlign(Alignment align)
setAlign in class StatefulCanvasalign - New align value. Default value is Canvas.CENTERStretchImgButton instance, for chaining setter callsAppearance overview and related methodspublic Alignment getAlign()
getAlign in class StatefulCanvasAppearance overview and related methodspublic StretchImgButton 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 StatefulCanvasautoFit - New autoFit setting. Default value is nullStretchImgButton instance, for chaining setter callsSizing overview and related methodspublic java.lang.Boolean getAutoFit()
setWidth() is explicitly called on an autoFit:true button, autoFit will be reset to false. Note that for StretchImgButton instances, autoFit will occur horizontally only, as unpredictable vertical sizing is likely to distort the media. If you do want vertical auto-fit, this can be achieved by simply setting a small height, and having overflow:"visible"
getAutoFit in class StatefulCanvasSizing overview and related methodspublic StretchImgButton setBaseStyle(java.lang.String baseStyle)
Note that if specified, this property takes precedence over any specified
StatefulCanvas.styleName. If unset, the
styleName will be used as a
default baseStyle value.
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
The Framework doesn't have built-in support for rotating button titles in a fashion
similar to FacetChart.rotateLabels. However, you
can manually configure
a button to render with a rotated title by applying custom CSS via this property.
For example, given a button with a height of 120 and a width of 48, if you copied the existing buttonXXX style declarations from skin_styles.css as new, rotatedTitleButtonXXX declarations, and then added the lines:
-ms-transform: translate(-38px,0px) rotate(270deg);
-webkit-transform: translate(-38px,0px) rotate(270deg);
transform: translate(-38px,0px) rotate(270deg);
overflow: hidden;
text-overflow: ellipsis;
width:116px;
in the declaration section beginning:
.rotatedTitleButton,
.rotatedTitleButtonSelected,
.rotatedTitleButtonSelectedOver,
.rotatedTitleButtonSelectedDown,
.rotatedTitleButtonSelectedDisabled,
.rotatedTitleButtonOver,
.rotatedTitleButtonDown,
.rotatedTitleButtonDisabled {
then applying that style to the button with overflow: "clip_h"
would yield a vertically-rendered title with overflow via ellipsis as expected, and also
wrap with Button.wrap.
Note that:
Note on css-margins: Developers should be aware that the css "margin" property is unreliable for
certain subclasses of StatefulCanvas, including buttons. Developers may use
the explicit Canvas.margin property to specify button margins, or
for a
button within a layout, consider the layout properties Layout.layoutMargin,
Layout.membersMargin
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 StatefulCanvasbaseStyle - new base style. Default value is "stretchImgButton"StretchImgButton instance, for chaining setter callsCSSStyleNamepublic java.lang.String getBaseStyle()
Note that if specified, this property takes precedence over any specified
StatefulCanvas.styleName. If unset, the
styleName will be used as a
default baseStyle value.
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
The Framework doesn't have built-in support for rotating button titles in a fashion
similar to FacetChart.rotateLabels. However, you
can manually configure
a button to render with a rotated title by applying custom CSS via this property.
For example, given a button with a height of 120 and a width of 48, if you copied the existing buttonXXX style declarations from skin_styles.css as new, rotatedTitleButtonXXX declarations, and then added the lines:
-ms-transform: translate(-38px,0px) rotate(270deg);
-webkit-transform: translate(-38px,0px) rotate(270deg);
transform: translate(-38px,0px) rotate(270deg);
overflow: hidden;
text-overflow: ellipsis;
width:116px;
in the declaration section beginning:
.rotatedTitleButton,
.rotatedTitleButtonSelected,
.rotatedTitleButtonSelectedOver,
.rotatedTitleButtonSelectedDown,
.rotatedTitleButtonSelectedDisabled,
.rotatedTitleButtonOver,
.rotatedTitleButtonDown,
.rotatedTitleButtonDisabled {
then applying that style to the button with overflow: "clip_h"
would yield a vertically-rendered title with overflow via ellipsis as expected, and also
wrap with Button.wrap.
Note that:
Note on css-margins: Developers should be aware that the css "margin" property is unreliable for
certain subclasses of StatefulCanvas, including buttons. Developers may use
the explicit Canvas.margin property to specify button margins, or
for a
button within a layout, consider the layout properties Layout.layoutMargin,
Layout.membersMargin
getBaseStyle in class StatefulCanvasCSSStyleNamepublic StretchImgButton setCapSize(int capSize)
setCapSize in class StretchImgcapSize - New capSize value. Default value is 12StretchImgButton instance, for chaining setter callsAppearance overview and related methodspublic int getCapSize()
getCapSize in class StretchImgAppearance overview and related methodspublic StretchImgButton setHeight(java.lang.Integer height)
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
setHeight in class StatefulCanvasheight - New height value. Default value is nullStretchImgButton instance, for chaining setter callsStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.Integer getHeight()
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
getHeight in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic void setHeight(java.lang.String height)
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
setHeight in class StatefulCanvasheight - New height value. Default value is nullStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.String getHeightAsString()
Canvas.height
for more details. Note that if StatefulCanvas.autoFit
is set on non-StretchImgButton instances, this property will be ignored so that the
widget is always sized just large enough to accommodate the title.
getHeightAsString in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic StretchImgButton 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 - New hiliteAccessKey value. Default value is trueStretchImgButton instance, for chaining setter callspublic 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 StretchImgButton setIcon(java.lang.String icon)
Specify as the partial URL to an image, relative to the
imgDir of this component. A sprited image can be specified using the SCSpriteConfig
format.
Note that the string "blank" is a valid setting for this attribute and will always result in the system
blank image, with no state suffixes applied. Typically, this might be used when an iconStyle is also specified and the
iconStyle renders the icon via a stateful background-image or other CSS approach.
If this method is called after the component has been drawn/initialized:
Change the icon being shown next to the title text.
setIcon in class StatefulCanvasicon - URL of new icon. Default value is nullStretchImgButton instance, for chaining setter callsSCImgURL,
ButtonIcon overview and related methodspublic java.lang.String getIcon()
Specify as the partial URL to an image, relative to the
imgDir of this component. A sprited image can be specified using the SCSpriteConfig
format.
Note that the string "blank" is a valid setting for this attribute and will always result in the system blank image, with no state suffixes applied. Typically, this might be used when an iconStyle is also specified and the iconStyle renders the icon via a stateful background-image or other CSS approach.
getIcon in class StatefulCanvasSCImgURL,
ButtonIcon overview and related methodspublic StretchImgButton setIconAlign(java.lang.String iconAlign) throws java.lang.IllegalStateException
iconAlign - New iconAlign value. Default value is nullStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.String getIconAlign()
ButtonIcon overview and related methodspublic StretchImgButton setIconHeight(java.lang.Integer iconHeight) throws java.lang.IllegalStateException
If unset, defaults to iconSize.
setIconHeight in class StatefulCanvasiconHeight - New iconHeight value. Default value is nullStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconHeight()
If unset, defaults to iconSize.
getIconHeight in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton setIconOrientation(java.lang.String iconOrientation) throws java.lang.IllegalStateException
"left" and "right".
setIconOrientation in class StatefulCanvasiconOrientation - The new orientation of the icon relative to the text of the button. Default value is "left"StretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.String getIconOrientation()
"left" and "right".getIconOrientation in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton 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 StatefulCanvasiconSize - New iconSize value. Default value is 16StretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic int getIconSize()
The iconWidth and
iconHeight properties can be used to configure width
and height separately.
Note: When configuring the properties of a StatefulCanvas (or derivative) AutoChild, it is best to set the iconWidth and iconHeight
to the same value rather than setting an iconSize. This is because certain skins or customizations thereto
might set the iconWidth and iconHeight, making the customization of the AutoChild's
iconSize ineffective.
getIconSize in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton setIconSpacing(int iconSpacing) throws java.lang.IllegalStateException
iconSpacing - New iconSpacing value. Default value is 6StretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic int getIconSpacing()
ButtonIcon overview and related methodspublic StretchImgButton setIconWidth(java.lang.Integer iconWidth) throws java.lang.IllegalStateException
If unset, defaults to iconSize.
setIconWidth in class StatefulCanvasiconWidth - New iconWidth value. Default value is nullStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Integer getIconWidth()
If unset, defaults to iconSize.
getIconWidth in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton 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 - New labelBreadthPad value. Default value is nullStretchImgButton instance, for chaining setter callspublic 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 StretchImgButton 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.
setLabelHPad in class StatefulCanvaslabelHPad - New labelHPad value. Default value is nullStretchImgButton instance, for chaining setter callssetLabelHPad(java.lang.Integer)public 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.
getLabelHPad in class StatefulCanvasgetLabelHPad()public StretchImgButton 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 - New labelLengthPad value. Default value is nullStretchImgButton instance, for chaining setter callspublic 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 StretchImgButton 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 nullStretchImgButton instance, for chaining setter callsURLpublic 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
URLpublic StretchImgButton 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.
setLabelVPad in class StatefulCanvaslabelVPad - New labelVPad value. Default value is nullStretchImgButton instance, for chaining setter callssetLabelVPad(java.lang.Integer)public 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.
getLabelVPad in class StatefulCanvasgetLabelVPad()public StretchImgButton setRadioGroup(java.lang.String radioGroup)
Note : This is an advanced setting
setRadioGroup in class StatefulCanvasradioGroup - New radioGroup value. Default value is nullStretchImgButton instance, for chaining setter callsState overview and related methodspublic java.lang.String getRadioGroup()
getRadioGroup in class StatefulCanvasState overview and related methodspublic StretchImgButton setShowClippedTitleOnHover(java.lang.Boolean showClippedTitleOnHover)
showClippedTitleOnHover - New showClippedTitleOnHover value. Default value is falseStretchImgButton instance, for chaining setter callspublic java.lang.Boolean getShowClippedTitleOnHover()
public StretchImgButton setShowDisabled(java.lang.Boolean showDisabled)
setShowDisabled in class StatefulCanvasshowDisabled - New showDisabled value. Default value is trueStretchImgButton instance, for chaining setter callsState overview and related methodspublic java.lang.Boolean getShowDisabled()
getShowDisabled in class StatefulCanvasState overview and related methodspublic StretchImgButton setShowDisabledIcon(java.lang.Boolean showDisabledIcon) throws java.lang.IllegalStateException
setShowDisabledIcon in class StatefulCanvasshowDisabledIcon - New showDisabledIcon value. Default value is trueStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowDisabledIcon()
getShowDisabledIcon in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton setShowDown(java.lang.Boolean showDown)
setShowDown in class StatefulCanvasshowDown - New showDown value. Default value is falseStretchImgButton instance, for chaining setter callsState overview and related methodspublic java.lang.Boolean getShowDown()
getShowDown in class StatefulCanvasState overview and related methodspublic StretchImgButton setShowDownIcon(java.lang.Boolean showDownIcon) throws java.lang.IllegalStateException
setShowDownIcon in class StatefulCanvasshowDownIcon - New showDownIcon value. Default value is falseStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowDownIcon()
getShowDownIcon in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton 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 StatefulCanvasshowFocused - New showFocused value. Default value is falseStretchImgButton instance, for chaining setter callsState overview and related methodspublic 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 StatefulCanvasState overview and related methodspublic StretchImgButton 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 StatefulCanvasshowFocusedIcon - New showFocusedIcon value. Default value is falseStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowFocusedIcon()
If StatefulCanvas.showFocusedAsOver is true, the
"Over" icon will be displayed when the canvas has focus, otherwise a separate "Focused" icon
will be displayed
getShowFocusedIcon in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton setShowRollOver(java.lang.Boolean showRollOver)
setShowRollOver in class StatefulCanvasshowRollOver - New showRollOver value. Default value is falseStretchImgButton instance, for chaining setter callsState overview and related methodspublic java.lang.Boolean getShowRollOver()
getShowRollOver in class StatefulCanvasState overview and related methodspublic StretchImgButton setShowRollOverIcon(java.lang.Boolean showRollOverIcon) throws java.lang.IllegalStateException
setShowRollOverIcon in class StatefulCanvasshowRollOverIcon - New showRollOverIcon value. Default value is falseStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowRollOverIcon()
getShowRollOverIcon in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton setShowSelectedIcon(java.lang.Boolean showSelectedIcon) throws java.lang.IllegalStateException
setShowSelectedIcon in class StatefulCanvasshowSelectedIcon - New showSelectedIcon value. Default value is falseStretchImgButton instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the component has been createdButtonIcon overview and related methodspublic java.lang.Boolean getShowSelectedIcon()
getShowSelectedIcon in class StatefulCanvasButtonIcon overview and related methodspublic StretchImgButton setShowTitle(java.lang.Boolean showTitle)
title will be displayed
for this component.setShowTitle in class StretchImgshowTitle - New showTitle value. Default value is trueStretchImgButton instance, for chaining setter callspublic java.lang.Boolean getShowTitle()
title will be displayed
for this component.getShowTitle in class StretchImgpublic StretchImgButton 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 StretchImgsrc - New src value. Default value is "button.gif"StretchImgButton instance, for chaining setter callsSCImgURLpublic 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 StretchImgSCImgURLpublic StretchImgButton 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 StatefulCanvasstate - the new state. Default value is ""StretchImgButton instance, for chaining setter callsState,
State overview and related methodspublic 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 StatefulCanvasState,
State overview and related methodspublic void setTitle(java.lang.String title)
title.setTitle in class StatefulCanvastitle - the new title HTML. Default value is nullHTMLString,
Basics overview and related methodspublic java.lang.String getTitle()
getTitle in class StatefulCanvasDefault is to simply return this.title. Default value is null
HTMLString,
Basics overview and related methodspublic StretchImgButton 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 StatefulCanvastitleStyle - new title style. Default value is nullStretchImgButton instance, for chaining setter callsCSSStyleNamepublic 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.
CSSStyleNamepublic StretchImgButton setValign(VerticalAlignment valign)
setValign in class StatefulCanvasvalign - New valign value. Default value is Canvas.CENTERStretchImgButton instance, for chaining setter callsAppearance overview and related methodspublic VerticalAlignment getValign()
getValign in class StatefulCanvasAppearance overview and related methodspublic StretchImgButton setVertical(java.lang.Boolean vertical)
setVertical in class StretchImgvertical - New vertical value. Default value is falseStretchImgButton instance, for chaining setter callsAppearance overview and related methodspublic java.lang.Boolean getVertical()
getVertical in class StretchImgAppearance overview and related methodspublic StretchImgButton setWidth(java.lang.Integer width)
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
setWidth in class StatefulCanvaswidth - New width value. Default value is nullStretchImgButton instance, for chaining setter callsStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.Integer getWidth()
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
getWidth in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic void setWidth(java.lang.String width)
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
setWidth in class StatefulCanvaswidth - New width value. Default value is nullStatefulCanvas.setAutoFit(java.lang.Boolean),
Sizing overview and related methodspublic java.lang.String getWidthAsString()
Canvas.width
for more details. Note that if StatefulCanvas.autoFit
is set, this property will be ignored so that the widget is always sized just large enough to accommodate the title.
getWidthAsString in class StatefulCanvasStatefulCanvas.getAutoFit(),
Sizing overview and related methodspublic StretchImgButton setWrap(java.lang.Boolean wrap)
wrap - New wrap value. Default value is nullStretchImgButton instance, for chaining setter callspublic java.lang.Boolean getWrap()
public void action()
public void addToRadioGroup(java.lang.String groupID)
addToRadioGroup in class StatefulCanvasgroupID - - ID of the radiogroup to which this widget should be addedState overview and related methodspublic void deselect()
deselect in class StatefulCanvasState overview and related methodspublic 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 HasIconClickHandlershandler - the iconClick handlerHandlerRegistration used to remove this handlerpublic void removeFromRadioGroup()
removeFromRadioGroup in class StatefulCanvasState overview and related methodspublic void removeFromRadioGroup(java.lang.String groupID)
removeFromRadioGroup in class StatefulCanvasgroupID - - optional radio group ID (to ensure the widget is removed from the appropriate
group.State overview and related methodspublic void select()
select in class StatefulCanvasState overview and related methodspublic 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 HasTitleHoverHandlershandler - 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 HTMLStringHTMLStringHTMLStringpublic 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 createdSGWTPropertiespublic 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 LogicalStructuregetLogicalStructure in class StretchImg