com.sap.ui.commons.client
Class ImageWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.ImageWidget

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.IsWidget

public class ImageWidget
extends com.sap.ui.core.client.ControlWidget

The class Image is the GWT wrapper for the Phoenix control: sap.ui.commons.Image.

A wrapper around the <IMG> tag. The image can be loaded from a remote or local server. There are various size setting options available, and the images can be combined with actions.

• Properties
  • src : String
    Relative or absolute URL where the image file is stored.
  • visible : boolean
    Invisible images are not rendered.
  • width : String
    When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.
  • height : String
    When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.
  • decorative : boolean
    A decorative image is included for design reasons. In the case accessibility mode is turned on, the tab would not not stop there.
  • alt : String
    The alternative text in case the image is not available or cannot be displayed.
• Aggregations
• Associations
• Events
  • press Event is fired when the user clicks on the control.

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: SAP AG)

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.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	ImageWidget() constructs the class ImageWidget
protected	ImageWidget(Image control) constructs the class ImageWidget
	ImageWidget(String id) constructs the class ImageWidget

Method Summary

void	attachPressEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user clicks on the control.
void	detachPressEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when the user clicks on the control.
String	getAlt() Getter for property alt The alternative text in case the image is not available or cannot be displayed.
Image	getControl() returns the reference to the Phoenix Control
String	getHeight() Getter for property height When the empty value is kept, the original size is not changed.
String	getSrc() Getter for property src Relative or absolute URL where the image file is stored.
String	getWidth() Getter for property width When the empty value is kept, the original size is not changed.
boolean	isDecorative() Getter for property decorative A decorative image is included for design reasons.
boolean	isVisible() Getter for property visible Invisible images are not rendered.
void	setAlt(String value) Setter for property alt
void	setDecorative(boolean value) Setter for property decorative Default value is: true
void	setHeight(String value) Setter for property height
void	setSrc(String value) Setter for property src
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width

Methods inherited from class com.sap.ui.core.client.ControlWidget

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ImageWidget

public ImageWidget()

constructs the class ImageWidget

ImageWidget

public ImageWidget(String id)

constructs the class ImageWidget

Parameters:

id - id of the ImageWidget

ImageWidget

protected ImageWidget(Image control)

constructs the class ImageWidget

Parameters:

control - reference to an existing Image

Method Detail

getControl

public Image getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getSrc

public String getSrc()

Getter for property src Relative or absolute URL where the image file is stored.

Returns:

the value of property src

setSrc

public void setSrc(String value)

Setter for property src

Parameters:

value - String

isVisible

public boolean isVisible()

Getter for property visible Invisible images are not rendered.

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

getWidth

public String getWidth()

Getter for property width When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getHeight

public String getHeight()

Getter for property height When the empty value is kept, the original size is not changed. It is also possible to make settings for width or height only, the overall size is maintained then, considering the aspect ratio.

Returns:

the value of property height

setHeight

public void setHeight(String value)

Setter for property height

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

isDecorative

public boolean isDecorative()

Getter for property decorative A decorative image is included for design reasons. In the case accessibility mode is turned on, the tab would not not stop there.

Returns:

the value of property decorative

setDecorative

public void setDecorative(boolean value)

Setter for property decorative
Default value is: true

Parameters:

value - boolean

getAlt

public String getAlt()

Getter for property alt The alternative text in case the image is not available or cannot be displayed.

Returns:

the value of property alt

setAlt

public void setAlt(String value)

Setter for property alt

Parameters:

value - String

attachPressEvent

public void attachPressEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is fired when the user clicks on the control.

Parameters:

listener - reference to the EventListener

detachPressEvent

public void detachPressEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is fired when the user clicks on the control.

Parameters:

listener - reference to the EventListener