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

Interface IWDTablePopinToggleCell

All Superinterfaces:

IWDAbstractTableCellVariant, IWDViewElement

public interface IWDTablePopinToggleCell

extends IWDAbstractTableCellVariant

Web Dynpro TablePopinToggleCell API. This cell variant is used to expand/collapse a table's popin. The Table.selectedPopin property is automatically updated when toggling the state.

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

static interface

IWDTablePopinToggleCell.IWDOnToggle Interface defining the parameter names for event onToggle.

Field Summary

static WDTableCellDesign

DEFAULT_CELL_DESIGN Default value of the cellDesign property is WDTableCellDesign.STANDARD.

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

DEFAULT_H_ALIGN, DEFAULT_VARIANT_KEY

Method Summary

void	bindCellDesign(IWDAttributeInfo attributeInfo) Binds the cellDesign property to the context attribute specified by the given attribute info.
void	bindCellDesign(String path) Binds the cellDesign property to the context attribute specified by the given path.
String	bindingOfCellDesign() Returns the binding path of the cellDesign property.
WDTableCellDesign	getCellDesign() Returns the value of the cellDesign property.
IWDAction	getOnToggle() Returns the action assigned to event onToggle.
IWDParameterMapping	mappingOfOnToggle() Returns the parameter mapping for event onToggle.
void	setCellDesign(WDTableCellDesign value) Sets the cellDesign property to the given value.
void	setOnToggle(IWDAction action) Assigns the given action to event onToggle.

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

bindHAlign, bindHAlign, bindingOfHAlign, getHAlign, getVariantKey, setHAlign, setVariantKey

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_CELL_DESIGN

public static final WDTableCellDesign DEFAULT_CELL_DESIGN

Default value of the cellDesign property is WDTableCellDesign.STANDARD.

Method Detail

getOnToggle

public IWDAction getOnToggle()

Returns the action assigned to event onToggle. This event is launched when toggling the expanded / collapsed state.

Returns:

the action assigned to event onToggle

See Also:

mappingOfOnToggle()

setOnToggle

public void setOnToggle(IWDAction action)

Assigns the given action to event onToggle.

Parameters:

action - the action assigned to the event

See Also:

getOnToggle()

mappingOfOnToggle

public IWDParameterMapping mappingOfOnToggle()

Returns the parameter mapping for event onToggle.

To pass UI element event parameter values into action handler parameters, a parameter mapping has to be defined. Add code like the following inside method wdDoModifyView() of the view controller:

 if (firstTime)
 {
   IWDTablePopinToggleCell myTablePopinToggleCell = (IWDTablePopinToggleCell) view.getElement("ID-of-TablePopinToggleCell");
   myTablePopinToggleCell.mappingOfOnToggle().addSourceMapping
   (
     IWDTablePopinToggleCell.IWDOnToggle.EXPANDED, // event parameter name
     "name-of-action-parameter" // (type boolean)
   ); 
 }

 

Event onToggle has the following parameters:

• boolean expanded
  Indicates if the Popin is now expanded or collapsed.

Returns:

the parameter mapping for event onToggle

See Also:

getOnToggle()

bindCellDesign

public void bindCellDesign(String path)

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

Parameters:

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

bindCellDesign

public void bindCellDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfCellDesign

public String bindingOfCellDesign()

Returns the binding path of the cellDesign property.

Returns:

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

getCellDesign

public WDTableCellDesign getCellDesign()

Returns the value of the cellDesign property.

The initial value is WDTableCellDesign.STANDARD.

Returns:

the current value of the cellDesign property

See Also:

setCellDesign(WDTableCellDesign)

setCellDesign

public void setCellDesign(WDTableCellDesign value)

Sets the cellDesign property to the given value.

Parameters:

value - the new value of the cellDesign property

See Also:

getCellDesign()