com.sap.tc.webdynpro.clientserver.uielib.standard.api

Interface IWDImage

All Superinterfaces:

IWDTableCellEditor, IWDTableMarkableCellEditor, IWDUIElement, IWDViewElement

public interface IWDImage

extends IWDUIElement, IWDTableCellEditor, IWDTableMarkableCellEditor

Web Dynpro Image API. Image is used to display an image resource. The image source is given by an URL specified in source, if the image cannot be loaded, the alternative text is given by alt. The size of the image is specified by height and width.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static boolean	DEFAULT_ADJUST_IMAGE_SIZE Default value of the adjustImageSize property is false.
static String	DEFAULT_ALT Default value of the alt property is "".
static int	DEFAULT_BORDER Default value of the border property is 0.
static String	DEFAULT_HEIGHT Default value of the height property is "".
static boolean	DEFAULT_IS_DECORATIVE Default value of the isDecorative property is false.
static String	DEFAULT_SOURCE Default value of the source property is "".
static String	DEFAULT_WIDTH Default value of the width property is "".

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindAdjustImageSize(IWDAttributeInfo attributeInfo) Binds the adjustImageSize property to the context attribute specified by the given attribute info.
void	bindAdjustImageSize(String path) Binds the adjustImageSize property to the context attribute specified by the given path.
void	bindAlt(IWDAttributeInfo attributeInfo) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindAlt(String path) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	bindBorder(IWDAttributeInfo attributeInfo) Binds the border property to the context attribute specified by the given attribute info.
void	bindBorder(String path) Binds the border property to the context attribute specified by the given path.
void	bindHeight(IWDAttributeInfo attributeInfo) Binds the height property to the context attribute specified by the given attribute info.
void	bindHeight(String path) Binds the height property to the context attribute specified by the given path.
String	bindingOfAdjustImageSize() Returns the binding path of the adjustImageSize property.
String	bindingOfAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
String	bindingOfBorder() Returns the binding path of the border property.
String	bindingOfHeight() Returns the binding path of the height property.
String	bindingOfIsDecorative() Returns the binding path of the isDecorative property.
String	bindingOfSource() Returns the binding path of the source property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindIsDecorative(IWDAttributeInfo attributeInfo) Binds the isDecorative property to the context attribute specified by the given attribute info.
void	bindIsDecorative(String path) Binds the isDecorative property to the context attribute specified by the given path.
void	bindSource(IWDAttributeInfo attributeInfo) Binds the source property to the context attribute specified by the given attribute info.
void	bindSource(String path) Binds the source property to the context attribute specified by the given path.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds the width property to the context attribute specified by the given attribute info.
void	bindWidth(String path) Binds the width property to the context attribute specified by the given path.
void	destroyMenu() Destroys the aggregated Menu element.
boolean	getAdjustImageSize() Returns the value of the adjustImageSize property.
String	getAlt() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
int	getBorder() Returns the value of the border property.
String	getHeight() Returns the value of the height property.
boolean	getIsDecorative() Returns the value of the isDecorative property.
IWDMenu	getMenu() Returns the aggregated Menu element.
String	getSource() Returns the value of the source property.
String	getWidth() Returns the value of the width property.
void	setAdjustImageSize(boolean value) Sets the adjustImageSize property to the given value.
void	setAlt(String value) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.
void	setBorder(int value) Sets the border property to the given value.
void	setHeight(String value) Sets the height property to the given value.
void	setIsDecorative(boolean value) Sets the isDecorative property to the given value.
void	setMenu(IWDMenu menu) Sets the aggregated Menu element.
void	setSource(String value) Sets the source property to the given value.
void	setWidth(String value) Sets the width property to the given value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_ADJUST_IMAGE_SIZE

public static final boolean DEFAULT_ADJUST_IMAGE_SIZE

Default value of the adjustImageSize property is false.

See Also:

Constant Field Values

DEFAULT_ALT

public static final String DEFAULT_ALT

Default value of the alt property is "".

See Also:

Constant Field Values

DEFAULT_BORDER

public static final int DEFAULT_BORDER

Default value of the border property is 0.

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final String DEFAULT_HEIGHT

Default value of the height property is "".

See Also:

Constant Field Values

DEFAULT_IS_DECORATIVE

public static final boolean DEFAULT_IS_DECORATIVE

Default value of the isDecorative property is false.

See Also:

Constant Field Values

DEFAULT_SOURCE

public static final String DEFAULT_SOURCE

Default value of the source property is "".

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

Method Detail

bindAdjustImageSize

public void bindAdjustImageSize(String path)

Binds the adjustImageSize property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the adjustImageSize property will be bound

bindAdjustImageSize

public void bindAdjustImageSize(IWDAttributeInfo attributeInfo)

Binds the adjustImageSize property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the adjustImageSize property will be bound

bindingOfAdjustImageSize

public String bindingOfAdjustImageSize()

Returns the binding path of the adjustImageSize property.

Returns:

the path of the context attribute to which the adjustImageSize property is currently bound

getAdjustImageSize

public boolean getAdjustImageSize()

Returns the value of the adjustImageSize property.

The initial value is false.

Determines if the size of the image should be adjusted according to the proportion of original height and width, but in line with the given height and width. If this param is false, Image will be skewed to have the given height and width

Returns:

the current value of the adjustImageSize property

See Also:

setAdjustImageSize(boolean)

setAdjustImageSize

public void setAdjustImageSize(boolean value)

Sets the adjustImageSize property to the given value.

Parameters:

value - the new value of the adjustImageSize property

See Also:

getAdjustImageSize()

bindAlt

public void bindAlt(String path)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Binds the alt property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the alt property will be bound

bindAlt

public void bindAlt(IWDAttributeInfo attributeInfo)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Binds the alt property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the alt property will be bound

bindingOfAlt

public String bindingOfAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Returns the binding path of the alt property.

Returns:

the path of the context attribute to which the alt property is currently bound

getAlt

public String getAlt()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Returns the value of the alt property.

The initial value is "".

Determines the alternative text for this image.

Returns:

the current value of the alt property

See Also:

setAlt(String)

setAlt

public void setAlt(String value)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Unnecessary attribute if the tooltip contains semantic information about the image.

Sets the alt property to the given value.

Parameters:

value - the new value of the alt property

See Also:

getAlt()

bindBorder

public void bindBorder(String path)

Binds the border property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the border property will be bound

bindBorder

public void bindBorder(IWDAttributeInfo attributeInfo)

Binds the border property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the border property will be bound

bindingOfBorder

public String bindingOfBorder()

Returns the binding path of the border property.

Returns:

the path of the context attribute to which the border property is currently bound

getBorder

public int getBorder()

Returns the value of the border property.

The initial value is 0.

Determines the width (in pixels) of the image border.

Returns:

the current value of the border property

See Also:

setBorder(int)

setBorder

public void setBorder(int value)

Sets the border property to the given value.

Parameters:

value - the new value of the border property

See Also:

getBorder()

bindHeight

public void bindHeight(String path)

Binds the height property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the height property will be bound

bindHeight

public void bindHeight(IWDAttributeInfo attributeInfo)

Binds the height property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the height property will be bound

bindingOfHeight

public String bindingOfHeight()

Returns the binding path of the height property.

Returns:

the path of the context attribute to which the height property is currently bound

getHeight

public String getHeight()

Returns the value of the height property.

The initial value is "".

Determines the height (CSS size) of this image.

Returns:

the current value of the height property

See Also:

setHeight(String)

setHeight

public void setHeight(String value)

Sets the height property to the given value.

Parameters:

value - the new value of the height property

See Also:

getHeight()

bindIsDecorative

public void bindIsDecorative(String path)

Binds the isDecorative property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the isDecorative property will be bound

bindIsDecorative

public void bindIsDecorative(IWDAttributeInfo attributeInfo)

Binds the isDecorative property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the isDecorative property will be bound

bindingOfIsDecorative

public String bindingOfIsDecorative()

Returns the binding path of the isDecorative property.

Returns:

the path of the context attribute to which the isDecorative property is currently bound

getIsDecorative

public boolean getIsDecorative()

Returns the value of the isDecorative property.

The initial value is false.

Marks an Image as decorative. That means it carries no further information for the user, it is only used visually. This kind of Image is not in the tab chain if the 508 mode is turned on.

Returns:

the current value of the isDecorative property

See Also:

setIsDecorative(boolean)

setIsDecorative

public void setIsDecorative(boolean value)

Sets the isDecorative property to the given value.

Parameters:

value - the new value of the isDecorative property

See Also:

getIsDecorative()

bindSource

public void bindSource(String path)

Binds the source property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the source property will be bound

bindSource

public void bindSource(IWDAttributeInfo attributeInfo)

Binds the source property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the source property will be bound

bindingOfSource

public String bindingOfSource()

Returns the binding path of the source property.

Returns:

the path of the context attribute to which the source property is currently bound

getSource

public String getSource()

Returns the value of the source property.

The initial value is "".

Determines the URL where this image gets its data.

Returns:

the current value of the source property

See Also:

setSource(String)

setSource

public void setSource(String value)

Sets the source property to the given value.

Parameters:

value - the new value of the source property

See Also:

getSource()

bindWidth

public void bindWidth(String path)

Binds the width property to the context attribute specified by the given path.

Parameters:

path - the context path of the attribute to which the width property will be bound

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

Binds the width property to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the width property will be bound

bindingOfWidth

public String bindingOfWidth()

Returns the binding path of the width property.

Returns:

the path of the context attribute to which the width property is currently bound

getWidth

public String getWidth()

Returns the value of the width property.

The initial value is "".

Determines the width (CSS size) of this image.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(String value)

Sets the width property to the given value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

getMenu

public IWDMenu getMenu()

Returns the aggregated Menu element. The attached menu.

Returns:

the aggregated Menu element

See Also:

setMenu(IWDMenu)

setMenu

public void setMenu(IWDMenu menu)

Sets the aggregated Menu element.

Parameters:

menu - the new menu

See Also:

getMenu()

destroyMenu

public void destroyMenu()

Destroys the aggregated Menu element. Destroyed view elements do not exist any longer in their view, i.e. a new element may be created with the same ID.