com.sap.tc.webdynpro.clientserver.uielib.pattern.api
Interface IWDPatternExpandFunction

All Superinterfaces:

IWDViewElement

public interface IWDPatternExpandFunction

extends IWDViewElement

Web Dynpro PatternExpandFunction API. The PatternExpandFunction draws the collapse/expand icon for the PatternContainer controls. This reflects the current state of the control. Typical implementations will allow the user to cycle through the three options: SMALL, MEDIUM, LARGE. The SMALL state will collapse the PatternContainer, the MEDIUM creates a half-expanded state, and the LARGE creates a fully expanded state. The implementation of the toggle must done by the application.

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 WDIconButtonFunctionStatus	DEFAULT_EXPAND_STATE Default value of property expandState.
static java.lang.String	DEFAULT_TOOLTIP Default value of property tooltip.

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.
void	bindExpandState(IWDAttributeInfo attributeInfo) Binds property expandState to the context attribute specified by the given attribute info.
void	bindExpandState(java.lang.String path) Binds property expandState to the context attribute specified by path.
java.lang.String	bindingOfEnabled() Binding path of property enabled.
java.lang.String	bindingOfExpandState() Binding path of property expandState.
java.lang.String	bindingOfTooltip() Binding path of property tooltip.
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.
IWDAbstractPatternContainer	getAbstractPatternContainer() Returns the current AbstractPatternContainer.
boolean	getEnabled() Returns the value of the enabled property.
WDIconButtonFunctionStatus	getExpandState() Returns the value of the expandState property.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
java.lang.String	getTooltip() Returns the value of the tooltip property.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
void	setEnabled(boolean value) Sets property enabled to the new value.
void	setExpandState(WDIconButtonFunctionStatus value) Sets property expandState to the new value.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.
void	setTooltip(java.lang.String value) Sets property tooltip 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_EXPAND_STATE

public static final WDIconButtonFunctionStatus DEFAULT_EXPAND_STATE

Default value of property expandState.

DEFAULT_TOOLTIP

public static final java.lang.String DEFAULT_TOOLTIP

Default value of property tooltip.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped. The action performed when the button is pressed.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Maps the event onAction to the given action.

Parameters:

action - the action for the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping of event onAction.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• WDIconButtonFunctionStatus expandState - State of the pressed function icon.

Returns:

parameter mapping list.

See Also:

getOnAction()

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 if this tab is enabled. A disabled tab cannot be activated and its contents cannot be displayed.

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

bindExpandState

public void bindExpandState(java.lang.String path)

Binds property expandState to the context attribute specified by path.

Parameters:

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

bindExpandState

public void bindExpandState(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfExpandState

public java.lang.String bindingOfExpandState()

Binding path of property expandState.

Returns:

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

getExpandState

public WDIconButtonFunctionStatus getExpandState()

Returns the value of the expandState property. The initial value is WDIconButtonFunctionStatus.LARGE. Sets the status of the icon button in the PatternExpandFunction control. For the parameter values see enumeration 'IconButtonFunctionStatus'.

Returns:

the current value of the expandState property

See Also:

setExpandState(WDIconButtonFunctionStatus)

setExpandState

public void setExpandState(WDIconButtonFunctionStatus value)

Sets property expandState to the new value.

Parameters:

value - the new value of the expandState property

See Also:

getExpandState()

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

getAbstractPatternContainer

public IWDAbstractPatternContainer getAbstractPatternContainer()

Returns the current AbstractPatternContainer.

Returns:

the current AbstractPatternContainer