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

Interface IWDTableSummaryHierarchyCell

All Superinterfaces:

IWDAbstractTableCellVariant, IWDViewElement

public interface IWDTableSummaryHierarchyCell

extends IWDAbstractTableCellVariant

Web Dynpro TableSummaryHierarchyCell API. A table cell which visualizes a summary cell which is able to collapse or expand the summed cells.

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

IWDTableSummaryHierarchyCell.IWDOnStatusAction Interface defining the parameter names for event onStatusAction.

Field Summary

static WDTableSummaryCellDesign	DEFAULT_CELL_DESIGN Default value of the cellDesign property is WDTableSummaryCellDesign.TOTAL.
static WDExpansionDirection	DEFAULT_EXPANSION_DIRECTION Default value of the expansionDirection property is WDExpansionDirection.UP.

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.
void	bindExpanded(IWDAttributeInfo attributeInfo) Binds the expanded property to the context attribute specified by the given attribute info.
void	bindExpanded(String path) Binds the expanded property to the context attribute specified by the given path.
void	bindExpansionDirection(IWDAttributeInfo attributeInfo) Binds the expansionDirection property to the context attribute specified by the given attribute info.
void	bindExpansionDirection(String path) Binds the expansionDirection property to the context attribute specified by the given path.
String	bindingOfCellDesign() Returns the binding path of the cellDesign property.
String	bindingOfExpanded() Returns the binding path of the expanded property.
String	bindingOfExpansionDirection() Returns the binding path of the expansionDirection property.
void	destroyEditor() Destroys the aggregated Editor element.
WDTableSummaryCellDesign	getCellDesign() Returns the value of the cellDesign property.
IWDTableCellEditor	getEditor() Returns the aggregated Editor element
boolean	getExpanded() Returns the value of the expanded property.
WDExpansionDirection	getExpansionDirection() Returns the value of the expansionDirection property.
IWDAction	getOnStatusAction() Returns the action assigned to event onStatusAction.
IWDParameterMapping	mappingOfOnStatusAction() Returns the parameter mapping for event onStatusAction.
void	setCellDesign(WDTableSummaryCellDesign value) Sets the cellDesign property to the given value.
void	setEditor(IWDTableCellEditor editor) Sets the aggregated Editor element.
void	setExpanded(boolean value) Sets the expanded property to the given value.
void	setExpansionDirection(WDExpansionDirection value) Sets the expansionDirection property to the given value.
void	setOnStatusAction(IWDAction action) Assigns the given action to event onStatusAction.

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 WDTableSummaryCellDesign DEFAULT_CELL_DESIGN

Default value of the cellDesign property is WDTableSummaryCellDesign.TOTAL.

DEFAULT_EXPANSION_DIRECTION

public static final WDExpansionDirection DEFAULT_EXPANSION_DIRECTION

Default value of the expansionDirection property is WDExpansionDirection.UP.

Method Detail

getOnStatusAction

public IWDAction getOnStatusAction()

Returns the action assigned to event onStatusAction. Is fired when the user wants to toggle the expansion state

Returns:

the action assigned to event onStatusAction

See Also:

mappingOfOnStatusAction()

setOnStatusAction

public void setOnStatusAction(IWDAction action)

Assigns the given action to event onStatusAction.

Parameters:

action - the action assigned to the event

See Also:

getOnStatusAction()

mappingOfOnStatusAction

public IWDParameterMapping mappingOfOnStatusAction()

Returns the parameter mapping for event onStatusAction.

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)
 {
   IWDTableSummaryHierarchyCell myTableSummaryHierarchyCell = (IWDTableSummaryHierarchyCell) view.getElement("ID-of-TableSummaryHierarchyCell");
   myTableSummaryHierarchyCell.mappingOfOnStatusAction().addSourceMapping
   (
     IWDTableSummaryHierarchyCell.IWDOnStatusAction.EXPANDED, // event parameter name
     "name-of-action-parameter" // (type boolean)
   ); 
 }

 

Event onStatusAction has the following parameters:

• boolean expanded
  Info of the expansion state after the user action has finished

Returns:

the parameter mapping for event onStatusAction

See Also:

getOnStatusAction()

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

Returns the value of the cellDesign property.

The initial value is WDTableSummaryCellDesign.TOTAL.

Returns:

the current value of the cellDesign property

See Also:

setCellDesign(WDTableSummaryCellDesign)

setCellDesign

public void setCellDesign(WDTableSummaryCellDesign value)

Sets the cellDesign property to the given value.

Parameters:

value - the new value of the cellDesign property

See Also:

getCellDesign()

bindExpanded

public void bindExpanded(String path)

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

Note: This property must be bound to the context!

Parameters:

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

bindExpanded

public void bindExpanded(IWDAttributeInfo attributeInfo)

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

Note: This property must be bound to the context!

Parameters:

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

bindingOfExpanded

public String bindingOfExpanded()

Returns the binding path of the expanded property.

Note: This property must be bound to the context!

Returns:

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

getExpanded

public boolean getExpanded()

Returns the value of the expanded property.

The initial value is false.

Note: This property must be bound to the context!

Defines if the summed are collapsed or expanded

Returns:

the current value of the expanded property

See Also:

setExpanded(boolean)

setExpanded

public void setExpanded(boolean value)

Sets the expanded property to the given value.

Note: This property must be bound to the context!

Parameters:

value - the new value of the expanded property

See Also:

getExpanded()

bindExpansionDirection

public void bindExpansionDirection(String path)

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

Parameters:

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

bindExpansionDirection

public void bindExpansionDirection(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfExpansionDirection

public String bindingOfExpansionDirection()

Returns the binding path of the expansionDirection property.

Returns:

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

getExpansionDirection

public WDExpansionDirection getExpansionDirection()

Returns the value of the expansionDirection property.

The initial value is WDExpansionDirection.UP.

Defines if the summary hiearchical cell collapses the summed cells above or below

Returns:

the current value of the expansionDirection property

See Also:

setExpansionDirection(WDExpansionDirection)

setExpansionDirection

public void setExpansionDirection(WDExpansionDirection value)

Sets the expansionDirection property to the given value.

Parameters:

value - the new value of the expansionDirection property

See Also:

getExpansionDirection()

getEditor

public IWDTableCellEditor getEditor()

Returns the aggregated Editor element.

Returns:

the aggregated Editor element

See Also:

setEditor(IWDTableCellEditor)

setEditor

public void setEditor(IWDTableCellEditor editor)

Sets the aggregated Editor element.

Parameters:

editor - the new editor

See Also:

getEditor()

destroyEditor

public void destroyEditor()

Destroys the aggregated Editor element. Destroyed view elements do not exist any longer in their view, i.e. a new element may be created with the same ID.