|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.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
public class Img
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, isElementSet, 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 | |
|---|---|
protected JavaScriptObject |
create()
|
String |
getAltText()
If specified this property will be included as the alt text for the image HMTL element. |
void |
getHoverHTML()
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. |
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). |
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 |
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). |
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.google.gwt.user.client.ui.Widget |
|---|
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents |
| Methods inherited from class com.google.gwt.user.client.ui.UIObject |
|---|
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, 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 |
|---|
public Img()
public Img(JavaScriptObject jsObj)
public Img(String src)
public Img(String src,
int width,
int height)
| Method Detail |
|---|
public static Img getOrCreateRef(JavaScriptObject jsObj)
protected JavaScriptObject create()
create in class StatefulCanvaspublic void setAltText(String altText)
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.
altText - altText Default value is nullAccessibility overview and related methodspublic String getAltText()
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.
Accessibility overview and related methods
public void setImageHeight(Integer imageHeight)
throws IllegalStateException
imageType settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
imageHeight - imageHeight Default value is null
IllegalStateException - this property cannot be changed after the component has been createdpublic Integer getImageHeight()
imageType settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
public void setImageType(ImageStyle imageType)
usePNGFix to false. See ImageStyle for further details.
imageType - new style of image rendering. Default value is Img.STRETCHAppearance overview and related methodspublic ImageStyle getImageType()
usePNGFix to false. See ImageStyle for further details.
Appearance overview and related methods
public void setImageWidth(Integer imageWidth)
throws IllegalStateException
imageType settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
imageWidth - imageWidth Default value is null
IllegalStateException - this property cannot be changed after the component has been createdpublic Integer getImageWidth()
imageType settings that would
normally use the image's natural size (applies to imageType
"center" and "normal" only).
public void setName(String name)
throws IllegalStateException
Note: this attribute is ignored if the imageType is set to "tile"
Note : This is an advanced setting
name - name Default value is "main"
IllegalStateException - this property cannot be changed after the component has been createdpublic void setPrompt(String prompt)
showHover is true.
setPrompt in class Canvasprompt - prompt Default value is nullpublic String getPrompt()
showHover is true.
getPrompt in class Canvaspublic void setShowTitle(Boolean showTitle)
title will be displayed
for this component.Note : This is an advanced setting
showTitle - showTitle Default value is falsepublic Boolean getShowTitle()
title will be displayed
for this component.
public void setSize(Integer size)
throws IllegalStateException
size - size Default value is null
IllegalStateException - this property cannot be changed after the component has been createdSizing overview and related methodspublic Integer getSize()
Sizing overview and related methodspublic void setSrc(String src)
If img.state is set, it's value will be appended to the URL before the
file extension.
For example, given an src of "findIcon.gif" and a state of "Disabled", the resulting
image name would be "findIcon_Disabled.gif". Compound states such as "Selected", "Focused" and "Over" or "Down" will
have an intervening underscore, resulting in, for example, "findIcon_Selected_Down.gif".
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.
src - new URL for the image. Default value is "blank.gif"Appearance overview and related methodspublic String getSrc()
If img.state is set, it's value will be appended to the URL before the
file extension.
For example, given an src of "findIcon.gif" and a state of "Disabled", the resulting
image name would be "findIcon_Disabled.gif". Compound states such as "Selected", "Focused" and "Over" or "Down" will
have an intervening underscore, resulting in, for example, "findIcon_Selected_Down.gif".
Appearance overview and related methods
public void setUsePNGFix(Boolean usePNGFix)
throws IllegalStateException
usePNGFix - usePNGFix Default value is true
IllegalStateException - this property cannot be changed after the component has been createdpublic Boolean getUsePNGFix()
public void getHoverHTML()
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.
getHoverHTML in class Canvaspublic void resetSrc()
src attribute has not
changed, but other state that affects the image URL (such as being selected) has changed.
public static void setDefaultProperties(Img imgProperties)
Note: This method is intended for setting default attributes only and will effect 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.
imgProperties - properties that should be used as new defaults when instances of this class are created
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||