com.smartgwt.client.widgets
Class Img

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.StatefulCanvas
                      extended by com.smartgwt.client.widgets.Img
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, 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, 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.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, nativeObject, scClassName
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Img()
           
Img(JavaScriptObject jsObj)
           
Img(String src)
           
Img(String src, int width, int height)
           
 
Method Summary
static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
          Changes the defaults for Canvas AutoChildren named autoChildName.
static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
          Changes the defaults for FormItem AutoChildren named autoChildName.
protected  JavaScriptObject create()
           
 String getAltText()
          If specified this property will be included as the alt text for the image HMTL element.
 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).
 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.
 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()
           
static Img getOrCreateRef(JavaScriptObject jsObj)
           
 String getPrompt()
          Prompt displayed in hover canvas if showHover is true.
 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
 Integer getSize()
          Convenience for setting height and width to the same value, at init time only
 String getSrc()
          The base filename for the image.
 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.
 void setAltText(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.
 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.
 void setImageHeight(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).
 void 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.
 void setImageWidth(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)
           
 void setName(String name)
          The value of this attribute is specified as the value of the 'name' attribute in the resulting HTML.
 void setPrompt(String prompt)
          Prompt displayed in hover canvas if showHover is true.
 void setShowTitle(Boolean showTitle)
          Determines whether any specified title will be displayed for this component.
Applies to Image-based components only, where the title will be rendered out in a label floating over the component
 void setSize(Integer size)
          Convenience for setting height and width to the same value, at init time only
 void setSrc(String src)
          The base filename for the image.
 void setUsePNGFix(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, getAutoFit, getBaseStyle, getIcon, getIconHeight, getIconOrientation, getIconSize, getIconStyle, getIconWidth, getIgnoreRTL, getOverCanvas, getOverCanvasConstructor, getRadioGroup, getRedrawOnStateChange, getSelected, getShowDisabled, getShowDisabledIcon, getShowDown, getShowDownIcon, getShowFocused, getShowFocusedAsOver, getShowFocusedIcon, getShowOverCanvas, getShowRollOver, getShowRollOverIcon, getShowRTLIcon, getShowSelectedIcon, getState, getStateSuffix, getTitle, getValign, isSelected, removeFromRadioGroup, removeFromRadioGroup, select, setActionType, setAlign, setAutoFit, setBaseStyle, setDefaultProperties, setIcon, setIconHeight, setIconOrientation, setIconSize, setIconStyle, setIconWidth, setIgnoreRTL, setLogicalStructure, setOverCanvasConstructor, setRadioGroup, setRedrawOnStateChange, setSelected, setShowDisabled, setShowDisabledIcon, setShowDown, setShowDownIcon, setShowFocused, setShowFocusedAsOver, setShowFocusedIcon, setShowOverCanvas, setShowRollOver, setShowRollOverIcon, setShowRTLIcon, setShowSelectedIcon, setState, setTitle, setTitleStyle, setValign
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, deparent, depeer, disable, enable, focus, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanFocus, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getClassName, getContentElement, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getElement, getElement, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFormItemAutoChild, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getKeepInParentRect, getLayoutAlign, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentCanvas, getParentElement, getPeers, getPercentBox, getPercentSource, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getShrinkElementOnHide, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUseBackMask, getUseDragMask, getUseNativeDrag, getUseOpacityFilter, getValuesManager, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, parentResized, printComponents, redraw, redraw, removeChild, removeChild, removePeer, removePeer, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanFocus, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setElement, setExtraSpace, setFacetId, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLogicalStructure, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentCanvas, setParentElement, setPeers, setPercentBox, setPercentSource, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setScrollbarConstructor, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setShrinkElementOnHide, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseBackMask, setUseDragMask, setUseNativeDrag, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateEditNode, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, 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, setDragTracker, setID, setJavaScriptObject, 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
 
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, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

Img

public Img()

Img

public Img(JavaScriptObject jsObj)

Img

public Img(String src)

Img

public Img(String src,
           int width,
           int height)
Method Detail

getOrCreateRef

public static Img getOrCreateRef(JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(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.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(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.
See Also:
AutoChildUsage

create

protected JavaScriptObject create()
Overrides:
create in class StatefulCanvas

setAltText

public void setAltText(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 - Default value is null
See Also:
Accessibility overview and related methods

getAltText

public 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:
String
See Also:
Accessibility overview and related methods

setImageHeight

public void setImageHeight(Integer imageHeight)
                    throws 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 - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getImageHeight

public 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:
Integer

setImageType

public void 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
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:
ImageStyle
See Also:
Appearance overview and related methods

setImageWidth

public void setImageWidth(Integer imageWidth)
                   throws 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 - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created

getImageWidth

public 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:
Integer

setName

public void setName(String name)
             throws 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

Parameters:
name - Default value is "main"
Throws:
IllegalStateException - this property cannot be changed after the component has been created

setPrompt

public void setPrompt(String prompt)
Prompt displayed in hover canvas if showHover is true.

Overrides:
setPrompt in class Canvas
Parameters:
prompt - Default value is null
See Also:
Hovers / Tooltips Example

getPrompt

public String getPrompt()
Prompt displayed in hover canvas if showHover is true.

Overrides:
getPrompt in class Canvas
Returns:
String
See Also:
Hovers / Tooltips Example

setShowTitle

public void setShowTitle(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 - Default value is false

getShowTitle

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

setSize

public void setSize(Integer size)
             throws IllegalStateException
Convenience for setting height and width to the same value, at init time only

Parameters:
size - Default value is null
Throws:
IllegalStateException - this property cannot be changed after the component has been created
See Also:
Sizing overview and related methods

getSize

public Integer getSize()
Convenience for setting height and width to the same value, at init time only

Returns:
Integer
See Also:
Sizing overview and related methods

setSrc

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

This value will be combined with any specified state to form a combined URL, changing the appearance of the component as the state changes.

The following table lists out the standard set of combined URLs that may be generated. Subclasses may support additional state-derived media of course. Note that the src URL will be split such that the extension is always applied to the end of the combined string. For example in the following table, if src was set to "blank.gif", the Selected+Focused URL would be "blank_Selected_Focused.gif".

URL for Img sourceDescription
src+extensionDefault URL
src+"_Selected"+extension Applied when selected is set to true
src+"_Focused"+extension Applied when the component has keyboard focus, if showFocused is true, and showFocusedAsOver is not true.
src+"_Over"+extension Applied when the user rolls over the component if showRollOver is set to true
src+"_Down"+extension Applied when the user presses the mouse button over over the component if showDown is set to true
src+"_Disabled"+extension Applied to disabled component if showDisabled is true.
Combined states
src+"_Selected_Focused"+extension Combined Selected and focused state
src+"_Selected_Over"+extension Combined Selected and rollOver state
src+"_Focused_Over"+extension Combined Focused and rollOver state
src+"_Selected_Focused_Over"+extension Combined Selected, Focused and rollOver state
src+"_Selected_Down"+extension Combined Selected and mouse-down state
src+"_Focused_Down"+extension Combined Focused and mouse-down state
src+"_Selected_Focused_Down"+extension Combined Selected, Focused and mouse-down state
src+"_Selected_Disabled"+extension Combined Selected and Disabled state


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 Img.resetSrc instead.

Parameters:
src - new URL for the image See SCImgURL . Default value is "blank.gif"
See Also:
Appearance overview and related methods

getSrc

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

This value will be combined with any specified state to form a combined URL, changing the appearance of the component as the state changes.

The following table lists out the standard set of combined URLs that may be generated. Subclasses may support additional state-derived media of course. Note that the src URL will be split such that the extension is always applied to the end of the combined string. For example in the following table, if src was set to "blank.gif", the Selected+Focused URL would be "blank_Selected_Focused.gif".

URL for Img sourceDescription
src+extensionDefault URL
src+"_Selected"+extension Applied when selected is set to true
src+"_Focused"+extension Applied when the component has keyboard focus, if showFocused is true, and showFocusedAsOver is not true.
src+"_Over"+extension Applied when the user rolls over the component if showRollOver is set to true
src+"_Down"+extension Applied when the user presses the mouse button over over the component if showDown is set to true
src+"_Disabled"+extension Applied to disabled component if showDisabled is true.
Combined states
src+"_Selected_Focused"+extension Combined Selected and focused state
src+"_Selected_Over"+extension Combined Selected and rollOver state
src+"_Focused_Over"+extension Combined Focused and rollOver state
src+"_Selected_Focused_Over"+extension Combined Selected, Focused and rollOver state
src+"_Selected_Down"+extension Combined Selected and mouse-down state
src+"_Focused_Down"+extension Combined Focused and mouse-down state
src+"_Selected_Focused_Down"+extension Combined Selected, Focused and mouse-down state
src+"_Selected_Disabled"+extension Combined Selected and Disabled state

Returns:
See SCImgURL
See Also:
Appearance overview and related methods

setUsePNGFix

public void setUsePNGFix(Boolean usePNGFix)
                  throws IllegalStateException
If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.

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

getUsePNGFix

public Boolean getUsePNGFix()
If false, never apply the png fix needed in Internet Explorer to make png transparency work correctly.

Returns:
Boolean

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

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)

getLogicalStructure

public com.smartgwt.logicalstructure.core.LogicalStructureObject getLogicalStructure()
Specified by:
getLogicalStructure in interface LogicalStructure
Overrides:
getLogicalStructure in class StatefulCanvas