com.sap.ui.commons.client
Class Image

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.Image

public class Image
extends com.sap.ui.core.client.Control

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.ui.commons.Image)

Constructor Summary

protected

Image() constructs the class Image hidden due to JavaScriptObject restriction

Method Summary

Image	attachPressEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when the user clicks on the control.
static Image	create() creates a new instance of the class Image
static Image	create(String idOrConfig) creates a new instance of the class Image
static Image	create(String id, String config) creates a new instance of the class Image
Image	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.
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.
Image	setAlt(String value) Setter for property alt
Image	setDecorative(boolean value) Setter for property decorative Default value is: true
Image	setHeight(String value) Setter for property height
Image	setSrc(String value) Setter for property src
Image	setVisible(boolean value) Setter for property visible Default value is: true
Image	setWidth(String value) Setter for property width

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

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

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

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Image

protected Image()

constructs the class Image
hidden due to JavaScriptObject restriction

Method Detail

create

public static Image create()

creates a new instance of the class Image

create

public static Image create(String idOrConfig)

creates a new instance of the class Image

Parameters:

id - id of the Image or configuration JSON string

create

public static Image create(String id,
                           String config)

creates a new instance of the class Image

Parameters:

id - id of the Image

config - configuration JSON string

getSrc

public final String getSrc()

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

Returns:

the value of property src

setSrc

public final Image setSrc(String value)

Setter for property src

Parameters:

value - String

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible images are not rendered.

Returns:

the value of property visible

setVisible

public final Image setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getWidth

public final 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 final Image setWidth(String value)

Setter for property width

Parameters:

value - String

Returns:

this to allow method chaining

getHeight

public final 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 final Image setHeight(String value)

Setter for property height

Parameters:

value - String

Returns:

this to allow method chaining

isDecorative

public final 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 final Image setDecorative(boolean value)

Setter for property decorative
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getAlt

public final 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 final Image setAlt(String value)

Setter for property alt

Parameters:

value - String

Returns:

this to allow method chaining

attachPressEvent

public final Image 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

Returns:

this to allow method chaining

detachPressEvent

public final Image 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

Returns:

this to allow method chaining