com.sap.tc.webdynpro.progmodel.api
Interface IWDUIElement

All Superinterfaces:

IWDViewElement

All Known Subinterfaces:

IWDAbstractActiveComponent, IWDAbstractButton, IWDAbstractCaption, IWDAbstractDropDown, IWDAbstractDropDownByIndex, IWDAbstractDropDownByKey, IWDAbstractIgsElement, IWDAbstractInputField, IWDAbstractPatternContainer, IWDBarCodeReader, IWDBusinessGraphics, IWDButton, IWDCaption, IWDCheckBox, IWDCheckBoxGroup, IWDDateNavigator, IWDDropDownByIndex, IWDDropDownByKey, IWDFileDownload, IWDFileUpload, IWDFunctionKey, IWDGeoMap, IWDGroup, IWDHorizontalGutter, IWDIFrame, IWDImage, IWDInputField, IWDInteractiveForm, IWDInvisibleElement, IWDLabel, IWDLink, IWDLinkToAction, IWDLinkToURL, IWDMessageArea, IWDOfficeControl, IWDPatternSequence, IWDPatternTabStrip, IWDPatternTray, IWDPhaseIndicator, IWDProgressIndicator, IWDRadioButton, IWDRadioButtonGroupByIndex, IWDRadioButtonGroupByKey, IWDRFIDReader, IWDRoadMap, IWDScrollContainer, IWDTable, IWDTabStrip, IWDTextEdit, IWDTextView, IWDTimedTrigger, IWDToolBarButton, IWDToolBarDropDownByIndex, IWDToolBarDropDownByKey, IWDToolBarInputField, IWDTransparentContainer, IWDTray, IWDTree, IWDUIElementContainer, IWDViewContainerUIElement

public interface IWDUIElement

extends IWDViewElement

Web Dynpro UIElement API. UIElement is the abstract base class of all UI elements. It defines a set of common properties and provides access to a layout data object.

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

Field Summary

static boolean	DEFAULT_ENABLED Default value of property enabled.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.
static WDVisibility	DEFAULT_VISIBLE Default value of property visible.

Method Summary

void	bindEnabled(IWDAttributeInfo attributeInfo) Binds property enabled to the context attribute specified by the given attribute info.
void	bindEnabled(java.lang.String path) Binds property enabled to the context attribute specified by path.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
java.lang.String	bindingOfVisible() Binding path of property visible.
void	bindTooltip(IWDAttributeInfo attributeInfo) Binds property tooltip to the context attribute specified by the given attribute info.
void	bindTooltip(java.lang.String path) Binds property tooltip to the context attribute specified by path.
void	bindVisible(IWDAttributeInfo attributeInfo) Binds property visible to the context attribute specified by the given attribute info.
void	bindVisible(java.lang.String path) Binds property visible to the context attribute specified by path.
IWDLayoutData	createLayoutData(java.lang.Class layoutDataInterface) Creates and sets layout data of the given type.
IWDUIElementContainer	getContainer() Returns the current Container.
boolean	getEnabled() Returns the value of the enabled property.
IWDLayoutData	getLayoutData() Gets the LayoutData instance.
java.lang.String	getTooltip() Returns the value of the tooltip property.
WDVisibility	getVisible() Returns the value of the visible property.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setTooltip(java.lang.String value) Sets property tooltip to the new value.
void	setVisible(WDVisibility value) Sets property visible to the new value.

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

getId, getView, requestFocus

Field Detail

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

Default value of property enabled.

DEFAULT_TOOLTIP

public static final java.lang.String DEFAULT_TOOLTIP

Default value of property tooltip.

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of property visible.

Method Detail

bindEnabled

public void bindEnabled(java.lang.String path)

Binds property enabled to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the enabled property is bound

bindEnabled

public void bindEnabled(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the enabled property is bound

bindingOfEnabled

public java.lang.String bindingOfEnabled()

Binding path of property enabled.

Returns:

the path of the context attribute to which the enabled is currently bound

getEnabled

public boolean getEnabled()

Returns the value of the enabled property. The initial value is true. Determines whether the UI element is enabled. An enabled UI element can respond to user input and generate events.

Returns:

the current value of the enabled property

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean value)

Sets property enabled to the new value.

Parameters:

value - the new value of the enabled property

See Also:

getEnabled()

bindTooltip

public void bindTooltip(java.lang.String path)

Binds property tooltip to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the tooltip property is bound

bindTooltip

public void bindTooltip(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the tooltip property is bound

bindingOfTooltip

public java.lang.String bindingOfTooltip()

Binding path of property tooltip.

Returns:

the path of the context attribute to which the tooltip is currently bound

getTooltip

public java.lang.String getTooltip()

Returns the value of the tooltip property. The initial value is null. The text that is displayed when the mouse cursor is moved onto the UI element.

Returns:

the current value of the tooltip property

See Also:

setTooltip(String)

setTooltip

public void setTooltip(java.lang.String value)

Sets property tooltip to the new value.

Parameters:

value - the new value of the tooltip property

See Also:

getTooltip()

bindVisible

public void bindVisible(java.lang.String path)

Binds property visible to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the visible property is bound

bindVisible

public void bindVisible(IWDAttributeInfo attributeInfo)

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

Parameters:

attributeInfo - the info of the context attribute to which the visible property is bound

bindingOfVisible

public java.lang.String bindingOfVisible()

Binding path of property visible.

Returns:

the path of the context attribute to which the visible is currently bound

getVisible

public WDVisibility getVisible()

Returns the value of the visible property. The initial value is WDVisibility.VISIBLE. Determines whether the UI element is visible.

Returns:

the current value of the visible property

See Also:

setVisible(WDVisibility)

setVisible

public void setVisible(WDVisibility value)

Sets property visible to the new value.

Parameters:

value - the new value of the visible property

See Also:

getVisible()

getLayoutData

public IWDLayoutData getLayoutData()

Gets the LayoutData instance. A UI element may carry layout data that is used by the layout manager of its parent container.

Returns:

the current LayoutData

See Also:

createLayoutData(Class)

getContainer

public IWDUIElementContainer getContainer()

Returns the current Container. A container may contain a number of arbitrary UI elements called its children. The parent-child relation is used to construct the UI tree.

Returns:

the current Container

createLayoutData

public IWDLayoutData createLayoutData(java.lang.Class layoutDataInterface)

Creates and sets layout data of the given type.

Parameters:

layoutDataInterface - the type of layout data to be created

Returns:

the layout data created