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

Interface IWDButton

All Superinterfaces:

IWDAbstractButton, IWDAbstractCaption, IWDButtonRowItem, IWDTableCellEditor, IWDUIElement, IWDViewElement

public interface IWDButton

extends IWDAbstractButton, IWDButtonRowItem, IWDTableCellEditor

Web Dynpro Button API. Button represents a push button. Pressing the button triggers an action.

The action is required and must be set!

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 WDButtonDesign	DEFAULT_DESIGN Default value of the design property is WDButtonDesign.STANDARD.
static String	DEFAULT_EXPLANATION Default value of the explanation property is "".
static WDButtonSize	DEFAULT_SIZE Default value of the size property is WDButtonSize.STANDARD.
static String	DEFAULT_WIDTH Default value of the width property is "".

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractButton

DEFAULT_TEXT

Fields inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractCaption

DEFAULT_IMAGE_ALT, DEFAULT_IMAGE_FIRST, DEFAULT_IMAGE_SOURCE, DEFAULT_TEXT_DIRECTION

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindDesign(IWDAttributeInfo attributeInfo) Binds the design property to the context attribute specified by the given attribute info.
void	bindDesign(String path) Binds the design property to the context attribute specified by the given path.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfSize() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindSize(IWDAttributeInfo attributeInfo) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
void	bindSize(String path) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
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.
WDButtonDesign	getDesign() Returns the value of the design property.
String	getExplanation() Returns the value of the explanation property.
WDButtonSize	getSize() Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
String	getWidth() Returns the value of the width property.
void	setDesign(WDButtonDesign value) Sets the design property to the given value.
void	setExplanation(String explanation) Sets the explanation property to the given value.
void	setSize(WDButtonSize value) Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.
void	setWidth(String value) Sets the width property to the given value.

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractButton

bindingOfText, bindText, bindText, getOnAction, getText, mappingOfOnAction, setOnAction, setText

Methods inherited from interface com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractCaption

bindImageAlt, bindImageAlt, bindImageFirst, bindImageFirst, bindImageSource, bindImageSource, bindingOfImageAlt, bindingOfImageFirst, bindingOfImageSource, bindingOfTextDirection, bindTextDirection, bindTextDirection, getImageAlt, getImageFirst, getImageSource, getTextDirection, setImageAlt, setImageFirst, setImageSource, setTextDirection

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_DESIGN

public static final WDButtonDesign DEFAULT_DESIGN

Default value of the design property is WDButtonDesign.STANDARD.

DEFAULT_EXPLANATION

public static final String DEFAULT_EXPLANATION

Default value of the explanation property is "".

See Also:

Constant Field Values

DEFAULT_SIZE

public static final WDButtonSize DEFAULT_SIZE

Default value of the size property is WDButtonSize.STANDARD.

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

Default value of the width property is "".

See Also:

Constant Field Values

Method Detail

bindDesign

public void bindDesign(String path)

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

Parameters:

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

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDesign

public String bindingOfDesign()

Returns the binding path of the design property.

Returns:

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

getDesign

public WDButtonDesign getDesign()

Returns the value of the design property.

The initial value is WDButtonDesign.STANDARD.

The visual design of the button.

Returns:

the current value of the design property

See Also:

setDesign(WDButtonDesign)

setDesign

public void setDesign(WDButtonDesign value)

Sets the design property to the given value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

getExplanation

public String getExplanation()

Returns the value of the explanation property. The initial value is "". Determines the explanation text for this control. The explanation should be maintained by documentation developers in the development environment. The explanation is visualized at the button.

Returns:

the value of the explanation property

See Also:

setExplanation(String)

setExplanation

public void setExplanation(String explanation)

Sets the explanation property to the given value.

Parameters:

explanation - the new value of the explanation property

See Also:

getExplanation()

bindSize

public void bindSize(String path)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

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

Parameters:

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

bindSize

public void bindSize(IWDAttributeInfo attributeInfo)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

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

Parameters:

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

bindingOfSize

public String bindingOfSize()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Returns the binding path of the size property.

Returns:

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

getSize

public WDButtonSize getSize()

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Returns the value of the size property.

The initial value is WDButtonSize.STANDARD.

The abstract size of the button.

Returns:

the current value of the size property

See Also:

setSize(WDButtonSize)

setSize

public void setSize(WDButtonSize value)

Deprecated. This property may be withdrawn with the first new NetWeaver release in 2006 as it is no longer needed. Small UIElements are not supported anymore.

Sets the size property to the given value.

Parameters:

value - the new value of the size property

See Also:

getSize()

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

The width (CSS size) of the button.

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()