com.smartgwt.client.widgets

Class Img

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.smartgwt.client.widgets.BaseWidget

com.smartgwt.client.widgets.Canvas

com.smartgwt.client.widgets.StatefulCanvas

com.smartgwt.client.widgets.Img

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers

Direct Known Subclasses:

HeaderControl, ImgButton, ImgSplitbar, ToolStripSeparator

public class Img
extends StatefulCanvas

The Img widget class implements a simple widget that displays a single image.

See Also:

Stateful Images

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget

config, configOnly, factoryCreated, factoryProperties, id, nativeObject, scClassName

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Img()
Img(com.google.gwt.core.client.JavaScriptObject jsObj)
Img(java.lang.String src)
Img(java.lang.String src, int width, int height)

Method Summary

Modifier and Type	Method and Description
static void	changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren named autoChildName.
static void	changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren named autoChildName.
protected com.google.gwt.core.client.JavaScriptObject	create()
java.lang.String	getAltText() If specified this property will be included as the alt text for the image HMTL element.
java.lang.String	getEditProxyConstructor() Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
java.lang.Integer	getImageHeight() Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).
java.lang.Integer	getImageSize() Convenience for setting the ${isc.DocUtils.linkForRef('attr:Img.imageWidth','imageWidth) and \n imageHeight') attributes to the same value, for cases where imageType settings would normally use the image's natural size (applies to imageType "center" and "normal" only).
ImageStyle	getImageType() Indicates whether the image should be tiled/cropped, stretched, or centered when the size of this widget does not match the size of the image.
java.lang.Integer	getImageWidth() Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).
com.smartgwt.logicalstructure.core.LogicalStructureObject	getLogicalStructure() Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
static Img	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
java.lang.String	getPrompt() Prompt displayed in hover canvas if showHover is true.
java.lang.Boolean	getShowDisabled() Should we visibly change state when disabled?
java.lang.Boolean	getShowDown() Should we visibly change state when the mouse goes down in this object? This will impact the styling of the component on mouse down.
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	getShowFocusedAsOver() If showFocused is true for this widget, should the "over" state be used to indicate the widget as focused.
java.lang.Boolean	getShowImageDisabled() Should the image be updated when disabled as described in StatefulImages?
java.lang.Boolean	getShowImageDown() Should the image be updated on mouse down as described in StatefulImages?
java.lang.Boolean	getShowImageFocused() Should the image be updated on focus as described in StatefulImages?
java.lang.Boolean	getShowImageFocusedAsOver() If src is defined as a string, and this component is configured to show focused state images, this property will cause the "over" state image to be used to indicate focused state.
java.lang.Boolean	getShowImageRollOver() Should the image be updated on rollOver as described in StatefulImages?
java.lang.Boolean	getShowRollOver() Should we visibly change state when the mouse goes over this object?
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.Integer	getSize() Convenience for setting the ${isc.DocUtils.linkForRef('attr:StatefulCanvas.width','width) and height') of this widget to the same value, at init time only.
java.lang.String	getSrc() The base filename or stateful image configuration for the image.
SCStatefulImgConfig	getSrcAsSCStatefulImgConfig() The base filename or stateful image configuration for the image.
java.lang.Boolean	getUsePNGFix() If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.
void	resetSrc() Refresh the image being shown.
Img	setAltText(java.lang.String altText) If specified this property will be included as the alt text for the image HMTL element.
static void	setDefaultProperties(Img imgProperties) Class level method to set the default properties of this class.
Img	setEditProxyConstructor(java.lang.String editProxyConstructor) Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
void	setHoverHTMLCustomizer(HoverHTMLCustomizer hoverHTMLCustomizer) If this.showHover is true, when the user holds the mouse over this Canvas for long enough to trigger a hover event, a hover canvas is shown by default.
Img	setImageHeight(java.lang.Integer imageHeight) Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).
Img	setImageSize(java.lang.Integer imageSize) Convenience for setting the ${isc.DocUtils.linkForRef('attr:Img.imageWidth','imageWidth) and \n imageHeight') attributes to the same value, for cases where imageType settings would normally use the image's natural size (applies to imageType "center" and "normal" only).
Img	setImageType(ImageStyle imageType) Indicates whether the image should be tiled/cropped, stretched, or centered when the size of this widget does not match the size of the image.
Img	setImageWidth(java.lang.Integer imageWidth) Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).
com.smartgwt.logicalstructure.core.LogicalStructureObject	setLogicalStructure(com.smartgwt.logicalstructure.widgets.ImgLogicalStructure s) Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
Img	setName(java.lang.String name) The value of this attribute is specified as the value of the 'name' attribute in the resulting HTML.
Img	setPrompt(java.lang.String prompt) Prompt displayed in hover canvas if showHover is true.
Img	setShowDisabled(java.lang.Boolean showDisabled) Should we visibly change state when disabled?
Img	setShowDown(java.lang.Boolean showDown) Should we visibly change state when the mouse goes down in this object? This will impact the styling of the component on mouse down.
Img	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.
Img	setShowFocusedAsOver(java.lang.Boolean showFocusedAsOver) If showFocused is true for this widget, should the "over" state be used to indicate the widget as focused.
Img	setShowImageDisabled(java.lang.Boolean showImageDisabled) Should the image be updated when disabled as described in StatefulImages?
Img	setShowImageDown(java.lang.Boolean showImageDown) Should the image be updated on mouse down as described in StatefulImages?
Img	setShowImageFocused(java.lang.Boolean showImageFocused) Should the image be updated on focus as described in StatefulImages?
Img	setShowImageFocusedAsOver(java.lang.Boolean showImageFocusedAsOver) If src is defined as a string, and this component is configured to show focused state images, this property will cause the "over" state image to be used to indicate focused state.
Img	setShowImageRollOver(java.lang.Boolean showImageRollOver) Should the image be updated on rollOver as described in StatefulImages?
Img	setShowRollOver(java.lang.Boolean showRollOver) Should we visibly change state when the mouse goes over this object?
Img	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
Img	setSize(java.lang.Integer size) Convenience for setting the ${isc.DocUtils.linkForRef('attr:StatefulCanvas.width','width) and height') of this widget to the same value, at init time only.
Img	setSrc(SCStatefulImgConfig src) The base filename or stateful image configuration for the image.
Img	setSrc(java.lang.String src) The base filename or stateful image configuration for the image.
Img	setUsePNGFix(java.lang.Boolean usePNGFix) If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.

Methods inherited from class com.smartgwt.client.widgets.StatefulCanvas

addToRadioGroup, deselect, getActionType, getAlign, getAriaLabel, getAriaStateDefaults, getAutoFit, getBaseStyle, getHeight, getHeightAsString, getIcon, getIconHeight, getIconOrientation, getIconSize, getIconStyle, getIconWidth, getIgnoreRTL, getLabelHPad, getLabelVPad, getOverCanvas, getOverCanvasConstructor, getRadioGroup, getRedrawOnStateChange, getSelected, getShowDisabledIcon, getShowDownIcon, getShowFocusedIcon, getShowMenuOnClick, getShowOverCanvas, getShowRollOverIcon, getShowRTLIcon, getShowSelectedIcon, getState, getStateSuffix, getStyleName, getTitle, getValign, getVIconStyle, getWidth, getWidthAsString, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setAlign, setAriaLabel, setAutoFit, setBaseStyle, setDefaultProperties, setHeight, setHeight, setIcon, setIconHeight, setIconOrientation, setIconSize, setIconStyle, setIconWidth, setIgnoreRTL, setLabelHPad, setLabelVPad, setLogicalStructure, setOverCanvasConstructor, setRadioGroup, setRedrawOnStateChange, setSelected, setShowDisabledIcon, setShowDownIcon, setShowFocusedIcon, setShowMenuOnClick, setShowOverCanvas, setShowRollOverIcon, setShowRTLIcon, setShowSelectedIcon, setState, setStyleName, setTitle, setTitleFormatter, setTitleStyle, setValign, setVIconStyle, setWidth, setWidth

Methods inherited from class com.smartgwt.client.widgets.Canvas

addChild, 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, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, 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, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, 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, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, 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, setDefiningProperty, setDefiningPropertyNameOptions, 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, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, 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, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDrop

Methods inherited from class com.smartgwt.client.widgets.BaseWidget

addDrawHandler, 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, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

Img

public Img()

Img

public Img(com.google.gwt.core.client.JavaScriptObject jsObj)

Img

public Img(java.lang.String src)

Img

public Img(java.lang.String src,
           int width,
           int height)

Method Detail

getOrCreateRef

public static Img getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)

Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:

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.

See Also:

AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)

Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:

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.

See Also:

AutoChildUsage

create

protected com.google.gwt.core.client.JavaScriptObject create()

Overrides:

create in class StatefulCanvas

setAltText

public Img setAltText(java.lang.String altText)

If specified this property will be included as the alt text for the image HMTL element. This is useful for improving application accessibility.

altText and hover prompt / tooltip behavior: Note that some browsers, including Internet Explorer 9, show a native hover tooltip containing the img tag's alt attribute. Developers should not rely on this behavior to show the user a hover prompt - instead the prompt attribute should be used.
To set alt text and ensure a hover prompt shows up in all browsers, developers may set prompt and altText to the same value. If both these attributes are set, the standard Smart GWT prompt behavior will show a hover prompt in most browsers, but will be suppressed for browsers where a native tooltip is shown for altText. Note that setting altText and prompt to different values is not recommended - the prompt value will be ignored in favor of the altText in this case.

Parameters:

altText - New altText value. Default value is null

Returns:

Img instance, for chaining setter calls

See Also:

Accessibility / Section 508 compliance

getAltText

public java.lang.String getAltText()

If specified this property will be included as the alt text for the image HMTL element. This is useful for improving application accessibility.

altText and hover prompt / tooltip behavior: Note that some browsers, including Internet Explorer 9, show a native hover tooltip containing the img tag's alt attribute. Developers should not rely on this behavior to show the user a hover prompt - instead the prompt attribute should be used.
To set alt text and ensure a hover prompt shows up in all browsers, developers may set prompt and altText to the same value. If both these attributes are set, the standard Smart GWT prompt behavior will show a hover prompt in most browsers, but will be suppressed for browsers where a native tooltip is shown for altText. Note that setting altText and prompt to different values is not recommended - the prompt value will be ignored in favor of the altText in this case.

Returns:

Current altText value. Default value is null

See Also:

Accessibility / Section 508 compliance

setEditProxyConstructor

public Img setEditProxyConstructor(java.lang.String editProxyConstructor)
                            throws java.lang.IllegalStateException

Default class used to construct the EditProxy for this component when the component is first placed into edit mode.

Overrides:

setEditProxyConstructor in class StatefulCanvas

Parameters:

editProxyConstructor - New editProxyConstructor value. Default value is "ImgEditProxy"

Returns:

Img instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

SCClassName

getEditProxyConstructor

public java.lang.String getEditProxyConstructor()

Default class used to construct the EditProxy for this component when the component is first placed into edit mode.

Overrides:

getEditProxyConstructor in class StatefulCanvas

Returns:

Current editProxyConstructor value. Default value is "ImgEditProxy"

See Also:

SCClassName

setImageHeight

public Img setImageHeight(java.lang.Integer imageHeight)
                   throws java.lang.IllegalStateException

Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).

Parameters:

imageHeight - New imageHeight value. Default value is null

Returns:

Img instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

Appearance overview and related methods

getImageHeight

public java.lang.Integer getImageHeight()

Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).

Returns:

Current imageHeight value. Default value is null

See Also:

Appearance overview and related methods

setImageSize

public Img setImageSize(java.lang.Integer imageSize)
                 throws java.lang.IllegalStateException

Convenience for setting the ${isc.DocUtils.linkForRef('attr:Img.imageWidth','imageWidth) and \n imageHeight') attributes to the same value, for cases where imageType settings would normally use the image's natural size (applies to imageType "center" and "normal" only).

Parameters:

imageSize - New imageSize value. Default value is null

Returns:

Img instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

Appearance overview and related methods

getImageSize

public java.lang.Integer getImageSize()

Convenience for setting the ${isc.DocUtils.linkForRef('attr:Img.imageWidth','imageWidth) and \n imageHeight') attributes to the same value, for cases where imageType settings would normally use the image's natural size (applies to imageType "center" and "normal" only).

Returns:

Current imageSize value. Default value is null

See Also:

Appearance overview and related methods

setImageType

public Img setImageType(ImageStyle imageType)

Indicates whether the image should be tiled/cropped, stretched, or centered when the size of this widget does not match the size of the image. CENTER shows the image in it's natural size, but can't do so while the transparency fix is active for IE. The transparency fix can be manually disabled by setting usePNGFix to false. See ImageStyle for further details.

If this method is called after the component has been drawn/initialized: Change the style of image rendering.

Parameters:

imageType - new style of image rendering. Default value is Img.STRETCH

Returns:

Img instance, for chaining setter calls

See Also:

Appearance overview and related methods

getImageType

public ImageStyle getImageType()

Indicates whether the image should be tiled/cropped, stretched, or centered when the size of this widget does not match the size of the image. CENTER shows the image in it's natural size, but can't do so while the transparency fix is active for IE. The transparency fix can be manually disabled by setting usePNGFix to false. See ImageStyle for further details.

Returns:

Current imageType value. Default value is Img.STRETCH

See Also:

Appearance overview and related methods

setImageWidth

public Img setImageWidth(java.lang.Integer imageWidth)
                  throws java.lang.IllegalStateException

Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).

Parameters:

imageWidth - New imageWidth value. Default value is null

Returns:

Img instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

Appearance overview and related methods

getImageWidth

public java.lang.Integer getImageWidth()

Explicit size for the image, for imageType settings that would normally use the image's natural size (applies to imageType "center" and "normal" only).

Returns:

Current imageWidth value. Default value is null

See Also:

Appearance overview and related methods

setName

public Img setName(java.lang.String name)
            throws java.lang.IllegalStateException

The value of this attribute is specified as the value of the 'name' attribute in the resulting HTML.

Note: this attribute is ignored if the imageType is set to "tile"

Note : This is an advanced setting

Overrides:

setName in class Canvas

Parameters:

name - New name value. Default value is "main"

Returns:

Img instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

BaseWidget.setID(java.lang.String), Identifier

setPrompt

public Img setPrompt(java.lang.String prompt)

Prompt displayed in hover canvas if showHover is true.

Overrides:

setPrompt in class Canvas

Parameters:

prompt - New prompt value. Default value is null

Returns:

Img instance, for chaining setter calls

See Also:

HTMLString, Hovers / Tooltips Example

getPrompt

public java.lang.String getPrompt()

Prompt displayed in hover canvas if showHover is true.

Overrides:

getPrompt in class Canvas

Returns:

Current prompt value. Default value is null

See Also:

HTMLString, Hovers / Tooltips Example

setShowDisabled

public Img setShowDisabled(java.lang.Boolean showDisabled)

Should we visibly change state when disabled?

This will impact the styling of the component when disabled. It may also impact the image being displayed - see also showImageDisabled.

Overrides:

setShowDisabled in class StatefulCanvas

Parameters:

showDisabled - New showDisabled value. Default value is true

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowDisabled

public java.lang.Boolean getShowDisabled()

Should we visibly change state when disabled?

This will impact the styling of the component when disabled. It may also impact the image being displayed - see also showImageDisabled.

Overrides:

getShowDisabled in class StatefulCanvas

Returns:

Current showDisabled value. Default value is true

See Also:

State overview and related methods

setShowDown

public Img setShowDown(java.lang.Boolean showDown)

Should we visibly change state when the mouse goes down in this object? This will impact the styling of the component on mouse down. It may also impact the image being displayed - see also showImageDown.

Overrides:

setShowDown in class StatefulCanvas

Parameters:

showDown - New showDown value. Default value is false

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowDown

public java.lang.Boolean getShowDown()

Should we visibly change state when the mouse goes down in this object? This will impact the styling of the component on mouse down. It may also impact the image being displayed - see also showImageDown.

Overrides:

getShowDown in class StatefulCanvas

Returns:

Current showDown value. Default value is false

See Also:

State overview and related methods

setShowFocused

public Img 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. Otherwise a separate "focused" state will be used.

This will impact the styling of the component on focus. It may also impact the image being displayed - see also showImageFocused.

Overrides:

setShowFocused in class StatefulCanvas

Parameters:

showFocused - New showFocused value. Default value is false

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowFocused

public 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. Otherwise a separate "focused" state will be used.

This will impact the styling of the component on focus. It may also impact the image being displayed - see also showImageFocused.

Overrides:

getShowFocused in class StatefulCanvas

Returns:

Current showFocused value. Default value is false

See Also:

State overview and related methods

setShowFocusedAsOver

public Img setShowFocusedAsOver(java.lang.Boolean showFocusedAsOver)

If showFocused is true for this widget, should the "over" state be used to indicate the widget as focused. If set to false, a separate "focused" state will be used.

This property effects the css styling for the focused state.
If src is specified as a string it will also cause the "Over" media to be displayed to indicate focus, unless explicitly overridden by showImageFocusedAsOver. Note that this has no impact on the image to be displayed if src is specified as a SCStatefulImgConfig.

Overrides:

setShowFocusedAsOver in class StatefulCanvas

Parameters:

showFocusedAsOver - New showFocusedAsOver value. Default value is true

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowFocusedAsOver

public java.lang.Boolean getShowFocusedAsOver()

If showFocused is true for this widget, should the "over" state be used to indicate the widget as focused. If set to false, a separate "focused" state will be used.

This property effects the css styling for the focused state.
If src is specified as a string it will also cause the "Over" media to be displayed to indicate focus, unless explicitly overridden by showImageFocusedAsOver. Note that this has no impact on the image to be displayed if src is specified as a SCStatefulImgConfig.

Overrides:

getShowFocusedAsOver in class StatefulCanvas

Returns:

Current showFocusedAsOver value. Default value is true

See Also:

State overview and related methods

setShowImageDisabled

public Img setShowImageDisabled(java.lang.Boolean showImageDisabled)

Should the image be updated when disabled as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showDisabled will be used to determine whether to show a disabled image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Disabled state image will be displayed if defined.

Parameters:

showImageDisabled - New showImageDisabled value. Default value is null

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowImageDisabled

public java.lang.Boolean getShowImageDisabled()

Should the image be updated when disabled as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showDisabled will be used to determine whether to show a disabled image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Disabled state image will be displayed if defined.

Returns:

Current showImageDisabled value. Default value is null

See Also:

State overview and related methods

setShowImageDown

public Img setShowImageDown(java.lang.Boolean showImageDown)

Should the image be updated on mouse down as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showDown will be used to determine whether to show a mouse down image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Down state image will be displayed if defined.

Parameters:

showImageDown - New showImageDown value. Default value is null

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowImageDown

public java.lang.Boolean getShowImageDown()

Should the image be updated on mouse down as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showDown will be used to determine whether to show a mouse down image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Down state image will be displayed if defined.

Returns:

Current showImageDown value. Default value is null

See Also:

State overview and related methods

setShowImageFocused

public Img setShowImageFocused(java.lang.Boolean showImageFocused)

Should the image be updated on focus as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showFocused will be used to determine whether to show a focused image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Over state image will be displayed if defined.

Note that if src is defined as a string, the "Over" media may be used to indicate a focused state. See showFocusedAsOver and showImageFocusedAsOver.
This is not the case for components with src defined as a SCStatefulImgConfig configuration.

Parameters:

showImageFocused - New showImageFocused value. Default value is null

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowImageFocused

public java.lang.Boolean getShowImageFocused()

Should the image be updated on focus as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showFocused will be used to determine whether to show a focused image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Over state image will be displayed if defined.

Note that if src is defined as a string, the "Over" media may be used to indicate a focused state. See showFocusedAsOver and showImageFocusedAsOver.
This is not the case for components with src defined as a SCStatefulImgConfig configuration.

Returns:

Current showImageFocused value. Default value is null

See Also:

State overview and related methods

setShowImageFocusedAsOver

public Img setShowImageFocusedAsOver(java.lang.Boolean showImageFocusedAsOver)

If src is defined as a string, and this component is configured to show focused state images, this property will cause the "over" state image to be used to indicate focused state. (If unset, showFocusedAsOver will be consulted instead).

Note that this has no impact on the image to be displayed if src is specified as a SCStatefulImgConfig.

Parameters:

showImageFocusedAsOver - New showImageFocusedAsOver value. Default value is null

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowImageFocusedAsOver

public java.lang.Boolean getShowImageFocusedAsOver()

If src is defined as a string, and this component is configured to show focused state images, this property will cause the "over" state image to be used to indicate focused state. (If unset, showFocusedAsOver will be consulted instead).

Note that this has no impact on the image to be displayed if src is specified as a SCStatefulImgConfig.

Returns:

Current showImageFocusedAsOver value. Default value is null

See Also:

State overview and related methods

setShowImageRollOver

public Img setShowImageRollOver(java.lang.Boolean showImageRollOver)

Should the image be updated on rollOver as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showRollOver will be used to determine whether to show a roll-over image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Over state image will be displayed if defined.

Parameters:

showImageRollOver - New showImageRollOver value. Default value is null

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowImageRollOver

public java.lang.Boolean getShowImageRollOver()

Should the image be updated on rollOver as described in StatefulImages?

If not explicitly set, behavior is as follows:
If src is specified as a string, showRollOver will be used to determine whether to show a roll-over image.
If src is specified as a SCStatefulImgConfig, the appropriate SCStatefulImgConfig.Over state image will be displayed if defined.

Returns:

Current showImageRollOver value. Default value is null

See Also:

State overview and related methods

setShowRollOver

public Img setShowRollOver(java.lang.Boolean showRollOver)

Should we visibly change state when the mouse goes over this object?

This will impact the styling of the component on roll over. It may also impact the image being displayed - see also showImageRollOver.

Overrides:

setShowRollOver in class StatefulCanvas

Parameters:

showRollOver - New showRollOver value. Default value is false

Returns:

Img instance, for chaining setter calls

See Also:

State overview and related methods

getShowRollOver

public java.lang.Boolean getShowRollOver()

Should we visibly change state when the mouse goes over this object?

This will impact the styling of the component on roll over. It may also impact the image being displayed - see also showImageRollOver.

Overrides:

getShowRollOver in class StatefulCanvas

Returns:

Current showRollOver value. Default value is false

See Also:

State overview and related methods

setShowTitle

public Img 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

Note : This is an advanced setting

Parameters:

showTitle - New showTitle value. Default value is false

Returns:

Img instance, for chaining setter calls

getShowTitle

public 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

Returns:

Current showTitle value. Default value is false

setSize

public Img setSize(java.lang.Integer size)
            throws java.lang.IllegalStateException

Convenience for setting the ${isc.DocUtils.linkForRef('attr:StatefulCanvas.width','width) and height') of this widget to the same value, at init time only. See imageSize, or imageWidth / imageHeight, to control the size of the image itself for imageType settings that would normally use the image's natural size ("center" or "normal"), or where the image has no natural size, as with SVG Symbols.

Parameters:

size - New size value. Default value is null

Returns:

Img instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

See Also:

Sizing overview and related methods

getSize

public java.lang.Integer getSize()

Convenience for setting the ${isc.DocUtils.linkForRef('attr:StatefulCanvas.width','width) and height') of this widget to the same value, at init time only. See imageSize, or imageWidth / imageHeight, to control the size of the image itself for imageType settings that would normally use the image's natural size ("center" or "normal"), or where the image has no natural size, as with SVG Symbols.

Returns:

Current size value. Default value is null

See Also:

Sizing overview and related methods

setSrc

public Img setSrc(java.lang.String src)

The base filename or stateful image configuration for the image. Note that as the state of the component changes, the image displayed will be updated as described in StatefulImages.

If this method is called after the component has been drawn/initialized: Changes the URL of this image and redraws it.

Does nothing if the src has not changed - if src has not changed but other state has changed such that the image needs updating, call resetSrc() instead.

Parameters:

src - new URL for the image. Default value is "blank.gif"

Returns:

Img instance, for chaining setter calls

See Also:

SCImgURL, Appearance overview and related methods

getSrc

public java.lang.String getSrc()

The base filename or stateful image configuration for the image. Note that as the state of the component changes, the image displayed will be updated as described in StatefulImages.

Returns:

Current src value. Default value is "blank.gif"

See Also:

SCImgURL, Appearance overview and related methods

setSrc

public Img setSrc(SCStatefulImgConfig src)

The base filename or stateful image configuration for the image. Note that as the state of the component changes, the image displayed will be updated as described in StatefulImages.

If this method is called after the component has been drawn/initialized: Changes the URL of this image and redraws it.

Does nothing if the src has not changed - if src has not changed but other state has changed such that the image needs updating, call resetSrc() instead.

Parameters:

src - new URL for the image. Default value is "blank.gif"

Returns:

Img instance, for chaining setter calls

See Also:

SCImgURL, Appearance overview and related methods

getSrcAsSCStatefulImgConfig

public SCStatefulImgConfig getSrcAsSCStatefulImgConfig()

The base filename or stateful image configuration for the image. Note that as the state of the component changes, the image displayed will be updated as described in StatefulImages.

Returns:

Current src value. Default value is "blank.gif"

See Also:

SCImgURL, Appearance overview and related methods

setUsePNGFix

public Img setUsePNGFix(java.lang.Boolean usePNGFix)
                 throws java.lang.IllegalStateException

If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.

Parameters:

usePNGFix - New usePNGFix value. Default value is true

Returns:

Img instance, for chaining setter calls

Throws:

java.lang.IllegalStateException - this property cannot be changed after the component has been created

getUsePNGFix

public java.lang.Boolean getUsePNGFix()

If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.

Returns:

Current usePNGFix value. Default value is true

resetSrc

public void resetSrc()

Refresh the image being shown. Call this when the src attribute has not changed, but other state that affects the image URL (such as being selected) has changed.

See Also:

Appearance overview and related methods

setDefaultProperties

public static void setDefaultProperties(Img imgProperties)

Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

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.

Parameters:

imgProperties - properties that should be used as new defaults when instances of this class are created

See Also:

SGWTProperties

setHoverHTMLCustomizer

public void setHoverHTMLCustomizer(HoverHTMLCustomizer hoverHTMLCustomizer)

If this.showHover is true, when the user holds the mouse over this Canvas for long enough to trigger a hover event, a hover canvas is shown by default. This method returns the contents of that hover canvas.

Overridden from Canvas:
If prompt is specified, and altText is unset, default implementation is unchanged - the prompt text will be displayed in the hover.
If altText and prompt are set this method will return null to suppress the standard hover behavior in browsers where the alt attribute on an img tag causes a native tooltip to appear, such as Internet Explorer. On other browsers the altText value will be returned.

Parameters:

hoverHTMLCustomizer - the customizer to execute.

setLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject setLogicalStructure(com.smartgwt.logicalstructure.widgets.ImgLogicalStructure s)

Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()

Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

Specified by:

getLogicalStructure in interface LogicalStructure

Overrides:

getLogicalStructure in class StatefulCanvas