|
|||||||||
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()
|
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)
|
Boolean |
getShowTitle()
Determines whether any specified StatefulCanvas.getTitle() 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. |
void |
resetSrc()
Refresh the image being shown. |
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 |
setShowTitle(Boolean showTitle)
Determines whether any specified StatefulCanvas.getTitle() 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. |
Methods inherited from class com.google.gwt.user.client.ui.Widget |
---|
addDomHandler, addHandler, 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, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, 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 StatefulCanvas
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 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"
.
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.
src
- new URL for the image. Default value is "blank.gif"public 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"
.
public void setImageType(ImageStyle imageType)
imageType
- new style of image rendering. Default value is Img.STRETCHpublic ImageStyle getImageType()
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 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 setSize(Integer size) throws IllegalStateException
size
- size Default value is null
IllegalStateException
- this property cannot be changed after the component has been createdpublic Integer getSize()
public void setShowTitle(Boolean showTitle)
StatefulCanvas.getTitle()
will be displayed for this
component.Note : This is an advanced setting
showTitle
- showTitle Default value is falsepublic Boolean getShowTitle()
StatefulCanvas.getTitle()
will be displayed for this
component.
public void resetSrc()
src
attribute has not
changed, but other state that affects the image URL (such as being selected) has changed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |