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

All Superinterfaces:

IWDViewElement

public interface IWDTableColumn

extends IWDViewElement

Web Dynpro TableColumn API. TableColumn represents a single column in a table.

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

See Also:

IWDTable

Field Summary

static WDCellBackgroundDesign	DEFAULT_DESIGN Default value of property design.
static java.lang.String	DEFAULT_FILTER_VALUE Default value of property filterValue.
static WDTableColumnHAlign	DEFAULT_H_ALIGN Default value of property hAlign.
static boolean	DEFAULT_RESIZABLE Default value of property resizable.
static WDVisibility	DEFAULT_VISIBLE Default value of property visible.
static java.lang.String	DEFAULT_WIDTH Default value of property width.

Method Summary

void	bindDesign(IWDAttributeInfo attributeInfo) Binds property design to the context attribute specified by the given attribute info.
void	bindDesign(java.lang.String path) Binds property design to the context attribute specified by path.
void	bindFilterValue(IWDAttributeInfo attributeInfo) Binds property filterValue to the context attribute specified by the given attribute info.
void	bindFilterValue(java.lang.String path) Binds property filterValue to the context attribute specified by path.
void	bindHAlign(IWDAttributeInfo attributeInfo) Binds property hAlign to the context attribute specified by the given attribute info.
void	bindHAlign(java.lang.String path) Binds property hAlign to the context attribute specified by path.
java.lang.String	bindingOfDesign() Binding path of property design.
java.lang.String	bindingOfFilterValue() Binding path of property filterValue.
java.lang.String	bindingOfHAlign() Binding path of property hAlign.
java.lang.String	bindingOfResizable() Binding path of property resizable.
java.lang.String	bindingOfVisible() Binding path of property visible.
java.lang.String	bindingOfWidth() Binding path of property width.
void	bindResizable(IWDAttributeInfo attributeInfo) Binds property resizable to the context attribute specified by the given attribute info.
void	bindResizable(java.lang.String path) Binds property resizable 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.
void	bindWidth(IWDAttributeInfo attributeInfo) Binds property width to the context attribute specified by the given attribute info.
void	bindWidth(java.lang.String path) Binds property width to the context attribute specified by path.
void	destroyHeader() Destroys the Header instance.
void	destroyTableCellEditor() Destroys the TableCellEditor instance.
WDCellBackgroundDesign	getDesign() Returns the value of the design property.
java.lang.String	getFilterValue() Returns the value of the filterValue property.
WDTableColumnHAlign	getHAlign() Returns the value of the hAlign property.
IWDCaption	getHeader() Gets the Header instance.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
boolean	getResizable() Returns the value of the resizable property.
IWDTable	getTable() Returns the current Table.
IWDTableCellEditor	getTableCellEditor() Gets the TableCellEditor instance.
WDVisibility	getVisible() Returns the value of the visible property.
java.lang.String	getWidth() Returns the value of the width property.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
void	setDesign(WDCellBackgroundDesign value) Sets property design to the new value.
void	setFilterValue(java.lang.String value) Sets property filterValue to the new value.
void	setHAlign(WDTableColumnHAlign value) Sets property hAlign to the new value.
void	setHeader(IWDCaption header) Sets the Header instance.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.
void	setResizable(boolean value) Sets property resizable to the new value.
void	setTableCellEditor(IWDTableCellEditor tableCellEditor) Sets the TableCellEditor instance.
void	setVisible(WDVisibility value) Sets property visible to the new value.
void	setWidth(java.lang.String value) Sets property width to the new value.

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

getId, getView, requestFocus

Field Detail

DEFAULT_DESIGN

public static final WDCellBackgroundDesign DEFAULT_DESIGN

Default value of property design.

DEFAULT_FILTER_VALUE

public static final java.lang.String DEFAULT_FILTER_VALUE

Default value of property filterValue.

DEFAULT_H_ALIGN

public static final WDTableColumnHAlign DEFAULT_H_ALIGN

Default value of property hAlign.

DEFAULT_RESIZABLE

public static final boolean DEFAULT_RESIZABLE

Default value of property resizable.

DEFAULT_VISIBLE

public static final WDVisibility DEFAULT_VISIBLE

Default value of property visible.

DEFAULT_WIDTH

public static final java.lang.String DEFAULT_WIDTH

Default value of property width.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped. The action performed when the header of the tableColumn was clicked. Event parameters are the ID of the column where the selection occured.

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:

• String col - The ID of the selected column.

Returns:

parameter mapping list.

See Also:

getOnAction()

bindDesign

public void bindDesign(java.lang.String path)

Binds property design to the context attribute specified by path.

Parameters:

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

bindDesign

public void bindDesign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDesign

public java.lang.String bindingOfDesign()

Binding path of property design.

Returns:

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

getDesign

public WDCellBackgroundDesign getDesign()

Returns the value of the design property. The initial value is WDCellBackgroundDesign.TRANSPARENT.

Returns:

the current value of the design property

See Also:

setDesign(WDCellBackgroundDesign)

setDesign

public void setDesign(WDCellBackgroundDesign value)

Sets property design to the new value.

Parameters:

value - the new value of the design property

See Also:

getDesign()

bindFilterValue

public void bindFilterValue(java.lang.String path)

Binds property filterValue to the context attribute specified by path.

Parameters:

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

bindFilterValue

public void bindFilterValue(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfFilterValue

public java.lang.String bindingOfFilterValue()

Binding path of property filterValue.

Returns:

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

getFilterValue

public java.lang.String getFilterValue()

Returns the value of the filterValue property. The initial value is "".

Returns:

the current value of the filterValue property

See Also:

setFilterValue(String)

setFilterValue

public void setFilterValue(java.lang.String value)

Sets property filterValue to the new value.

Parameters:

value - the new value of the filterValue property

See Also:

getFilterValue()

bindHAlign

public void bindHAlign(java.lang.String path)

Binds property hAlign to the context attribute specified by path.

Parameters:

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

bindHAlign

public void bindHAlign(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfHAlign

public java.lang.String bindingOfHAlign()

Binding path of property hAlign.

Returns:

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

getHAlign

public WDTableColumnHAlign getHAlign()

Returns the value of the hAlign property. The initial value is WDTableColumnHAlign.AUTO.

Returns:

the current value of the hAlign property

See Also:

setHAlign(WDTableColumnHAlign)

setHAlign

public void setHAlign(WDTableColumnHAlign value)

Sets property hAlign to the new value.

Parameters:

value - the new value of the hAlign property

See Also:

getHAlign()

bindResizable

public void bindResizable(java.lang.String path)

Binds property resizable to the context attribute specified by path.

Parameters:

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

bindResizable

public void bindResizable(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfResizable

public java.lang.String bindingOfResizable()

Binding path of property resizable.

Returns:

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

getResizable

public boolean getResizable()

Returns the value of the resizable property. The initial value is true. Determines if the column is resizable or not

Returns:

the current value of the resizable property

See Also:

setResizable(boolean)

setResizable

public void setResizable(boolean value)

Sets property resizable to the new value.

Parameters:

value - the new value of the resizable property

See Also:

getResizable()

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 if this table column 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()

bindWidth

public void bindWidth(java.lang.String path)

Binds property width to the context attribute specified by path.

Parameters:

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

bindWidth

public void bindWidth(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfWidth

public java.lang.String bindingOfWidth()

Binding path of property width.

Returns:

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

getWidth

public java.lang.String getWidth()

Returns the value of the width property. The initial value is "". Determines the width (CSS size) of this table column.

Returns:

the current value of the width property

See Also:

setWidth(String)

setWidth

public void setWidth(java.lang.String value)

Sets property width to the new value.

Parameters:

value - the new value of the width property

See Also:

getWidth()

getHeader

public IWDCaption getHeader()

Gets the Header instance. The header of a table column contains a caption.

Returns:

the current Header

See Also:

setHeader(IWDCaption)

setHeader

public void setHeader(IWDCaption header)

Sets the Header instance.

Parameters:

header - the new header

See Also:

getHeader()

destroyHeader

public void destroyHeader()

Destroys the Header instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getTableCellEditor

public IWDTableCellEditor getTableCellEditor()

Gets the TableCellEditor instance. A table cell editor is used to display or edit the values in a table cell.

Returns:

the current TableCellEditor

See Also:

setTableCellEditor(IWDTableCellEditor)

setTableCellEditor

public void setTableCellEditor(IWDTableCellEditor tableCellEditor)

Sets the TableCellEditor instance.

Parameters:

tableCellEditor - the new tableCellEditor

See Also:

getTableCellEditor()

destroyTableCellEditor

public void destroyTableCellEditor()

Destroys the TableCellEditor instance. Destroyed elements do not exist any longer, i.e. a new element may be created with the same ID.

getTable

public IWDTable getTable()

Returns the current Table. A table contains a number of table columns.

Returns:

the current Table