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

Interface IWDAbstractToggleButton

All Superinterfaces:

IWDAbstractToggle, IWDUIElement, IWDViewElement

All Known Subinterfaces:

IWDToggleButton, IWDToolBarToggleButton

public interface IWDAbstractToggleButton

extends IWDAbstractToggle

Web Dynpro AbstractToggleButton API. Abstract base class of all toggle buttons.

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

Nested Class Summary

Nested classes inherited from class com.sap.tc.webdynpro.clientserver.uielib.standard.api.IWDAbstractToggle

IWDAbstractToggle.IWDOnToggle

Field Summary

static String	DEFAULT_CHECKED_IMAGE_SOURCE Default value of the checkedImageSource property is "".
static WDToggleButtonDesign	DEFAULT_DESIGN Default value of the design property is WDToggleButtonDesign.STANDARD.
static boolean	DEFAULT_IMAGE_FIRST Default value of the imageFirst property is true.
static String	DEFAULT_IMAGE_SOURCE Default value of the imageSource property is "".
static String	DEFAULT_TEXT Default value of the text property is "".
static String	DEFAULT_WIDTH Default value of the width property is "".

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

DEFAULT_TEXT_DIRECTION

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindCheckedImageSource(IWDAttributeInfo attributeInfo) Binds the checkedImageSource property to the context attribute specified by the given attribute info.
void	bindCheckedImageSource(String path) Binds the checkedImageSource property to the context attribute specified by the given path.
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.
void	bindImageFirst(IWDAttributeInfo attributeInfo) Binds the imageFirst property to the context attribute specified by the given attribute info.
void	bindImageFirst(String path) Binds the imageFirst property to the context attribute specified by the given path.
void	bindImageSource(IWDAttributeInfo attributeInfo) Binds the imageSource property to the context attribute specified by the given attribute info.
void	bindImageSource(String path) Binds the imageSource property to the context attribute specified by the given path.
String	bindingOfCheckedImageSource() Returns the binding path of the checkedImageSource property.
String	bindingOfDesign() Returns the binding path of the design property.
String	bindingOfImageFirst() Returns the binding path of the imageFirst property.
String	bindingOfImageSource() Returns the binding path of the imageSource property.
String	bindingOfText() Returns the binding path of the text property.
String	bindingOfWidth() Returns the binding path of the width property.
void	bindText(IWDAttributeInfo attributeInfo) Binds the text property to the context attribute specified by the given attribute info.
void	bindText(String path) Binds the text 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.
String	getCheckedImageSource() Returns the value of the checkedImageSource property.
WDToggleButtonDesign	getDesign() Returns the value of the design property.
boolean	getImageFirst() Returns the value of the imageFirst property.
String	getImageSource() Returns the value of the imageSource property.
String	getText() Returns the value of the text property.
String	getWidth() Returns the value of the width property.
void	setCheckedImageSource(String value) Sets the checkedImageSource property to the given value.
void	setDesign(WDToggleButtonDesign value) Sets the design property to the given value.
void	setImageFirst(boolean value) Sets the imageFirst property to the given value.
void	setImageSource(String value) Sets the imageSource property to the given value.
void	setText(String value) Sets the text 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.clientserver.uielib.standard.api.IWDAbstractToggle

bindChecked, bindChecked, bindingOfChecked, bindingOfTextDirection, bindTextDirection, bindTextDirection, getChecked, getOnToggle, getTextDirection, mappingOfOnToggle, setChecked, setOnToggle, 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_CHECKED_IMAGE_SOURCE

public static final String DEFAULT_CHECKED_IMAGE_SOURCE

Default value of the checkedImageSource property is "".

See Also:

Constant Field Values

DEFAULT_DESIGN

public static final WDToggleButtonDesign DEFAULT_DESIGN

Default value of the design property is WDToggleButtonDesign.STANDARD.

DEFAULT_IMAGE_FIRST

public static final boolean DEFAULT_IMAGE_FIRST

Default value of the imageFirst property is true.

See Also:

Constant Field Values

DEFAULT_IMAGE_SOURCE

public static final String DEFAULT_IMAGE_SOURCE

Default value of the imageSource property is "".

See Also:

Constant Field Values

DEFAULT_TEXT

public static final String DEFAULT_TEXT

Default value of the text 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

bindCheckedImageSource

public void bindCheckedImageSource(String path)

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

Parameters:

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

bindCheckedImageSource

public void bindCheckedImageSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfCheckedImageSource

public String bindingOfCheckedImageSource()

Returns the binding path of the checkedImageSource property.

Returns:

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

getCheckedImageSource

public String getCheckedImageSource()

Returns the value of the checkedImageSource property.

The initial value is null.

The checked image source given as an URL.

Returns:

the current value of the checkedImageSource property

See Also:

setCheckedImageSource(String)

setCheckedImageSource

public void setCheckedImageSource(String value)

Sets the checkedImageSource property to the given value.

Parameters:

value - the new value of the checkedImageSource property

See Also:

getCheckedImageSource()

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

Returns the value of the design property.

The initial value is WDToggleButtonDesign.STANDARD.

The visual design of the toggleButton.

Returns:

the current value of the design property

See Also:

setDesign(WDToggleButtonDesign)

setDesign

public void setDesign(WDToggleButtonDesign value)

Sets the design property to the given value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindImageFirst

public void bindImageFirst(String path)

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

Parameters:

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

bindImageFirst

public void bindImageFirst(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageFirst

public String bindingOfImageFirst()

Returns the binding path of the imageFirst property.

Returns:

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

getImageFirst

public boolean getImageFirst()

Returns the value of the imageFirst property.

The initial value is true.

Determines if the image is displayed on the left (imageFirst = true) or on the right of the text.

Returns:

the current value of the imageFirst property

See Also:

setImageFirst(boolean)

setImageFirst

public void setImageFirst(boolean value)

Sets the imageFirst property to the given value.

Parameters:

value - the new value of the imageFirst property

See Also:

getImageFirst()

bindImageSource

public void bindImageSource(String path)

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

Parameters:

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

bindImageSource

public void bindImageSource(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfImageSource

public String bindingOfImageSource()

Returns the binding path of the imageSource property.

Returns:

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

getImageSource

public String getImageSource()

Returns the value of the imageSource property.

The initial value is null.

The image source given as an URL.

Returns:

the current value of the imageSource property

See Also:

setImageSource(String)

setImageSource

public void setImageSource(String value)

Sets the imageSource property to the given value.

Parameters:

value - the new value of the imageSource property

See Also:

getImageSource()

bindText

public void bindText(String path)

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

Parameters:

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

bindText

public void bindText(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfText

public String bindingOfText()

Returns the binding path of the text property.

Returns:

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

getText

public String getText()

Returns the value of the text property.

The initial value is null.

The text of the toggle button.

Returns:

the current value of the text property

See Also:

setText(String)

setText

public void setText(String value)

Sets the text property to the given value.

Parameters:

value - the new value of the text property

See Also:

getText()

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

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