com.sapportals.admin.wizardframework.components.tableview

Class TableViewComponent

java.lang.Object
  com.sapportals.admin.wizardframework.components.AbstractWizardComponent
      com.sapportals.admin.wizardframework.components.AbstractInputComponent
          com.sapportals.admin.wizardframework.components.tableview.TableViewComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent, TableViewConstants, com.sapportals.htmlb.table.ICellRenderer

Direct Known Subclasses:

TableViewEditorComponent

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public class TableViewComponent
extends AbstractInputComponent
implements com.sapportals.htmlb.table.ICellRenderer, TableViewConstants

The class that is a wrapper for the HTMLB table view component. This wrapper component simplifies the use and elaborates on the options available to a regular HTMLB table view component. It can be used by both wizards and editors.

Field Summary

protected static String	EVENT_HEADER_SORT Deprecated.
protected static String	EVENT_ROW_SELECT Deprecated.

Fields inherited from class com.sapportals.admin.wizardframework.components.AbstractInputComponent

captionWidth, DEFAULT_PADDING, defaultCaption, defaultTooltip, defaultValue, filledIncompletely, INPUT_COMPONENT, inputComponent, label, layout, padding, VALUE, valueTargetPath

Fields inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Fields inherited from interface com.sapportals.admin.wizardframework.components.tableview.TableViewConstants

TABLE_STATE_TABLE_DATA_KEY, TABLE_VIEW_COMPONENT_KEY

Constructor Summary

TableViewComponent(IBasicEditingContext context)
Deprecated. A constructor that sets the context.

Method Summary

protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context) Deprecated. Creates an input component.
void	doBeforeDisplay(IWizardContext context) Deprecated. Performs synchronization between the data model and the pane.
protected TableViewColumns	getColumns() Deprecated. Gets the table view columns array member.
protected com.sapportals.htmlb.enums.TableSortState	getColumnSortedMode(int columnIndex, IBasicEditingContext context) Deprecated. Gets the sort state for each column during a header click event.
com.sapportals.htmlb.Component	getDisplay(IWizardContext context) Deprecated. Gets the HTMLB component to display.
com.sapportals.htmlb.table.TableView	getInputComponent(IBasicEditingContext ctx) Deprecated. Gets the table view input component.
TableDataModel	getTableState(IBasicEditingContext context) Deprecated. Gets the table data model object.
Boolean	isReadOnly(IBasicEditingContext context) Deprecated. Indicates whether the table view is in read-only mode.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	renderCell(int row, int column, com.sapportals.htmlb.table.TableView tableView, com.sapportals.htmlb.rendering.IPageContext rendererContext) Deprecated. Calls a renderer for each column.
void	setColumns(TableViewColumn[] iColumns, IBasicEditingContext context) Deprecated. Sets the table view column objects.
void	setDeselectAll(Boolean iDeselectAll, IBasicEditingContext context) Deprecated. Deselects all rows.
void	setOnClientRowSelection(String iOnRowSelJsFuncName, IBasicEditingContext context) Deprecated. Adds outside implementation during a select row event.
void	setReadOnly(Boolean iReadOnly, IBasicEditingContext context) Deprecated. Sets the table view to read-only mode.
void	setSelectAll(Boolean iSelectAll, IBasicEditingContext context) Deprecated. Selects all rows.
void	setSelectionMode(com.sapportals.htmlb.enums.TableSelectionMode selectionMode, IBasicEditingContext context) Deprecated. Sets a selection mode.

Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractInputComponent

clear, clearIfInconsistent, getCaption, getCaptionComponent, getErrorMessages, getInputComponentGeneric, getMissingFieldErrorMessage, getTooltip, getValueGeneric, isComplete, setCaption, setCaptionWidth, setCustomErrorMessage, setLayout, setPath, setTooltip, setupComponent, setValueGeneric, setValueTargetPath

Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

doAfterSubmit, getControlInFocus, getDescription, getPath, getProperty, getTitle, init, isInitialized, isMandatory, setMandatory, setProperty, setTempProperty, wasChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT_HEADER_SORT

protected static final String EVENT_HEADER_SORT

Deprecated.

See Also:

Constant Field Values

EVENT_ROW_SELECT

protected static final String EVENT_ROW_SELECT

Deprecated.

See Also:

Constant Field Values

Constructor Detail

TableViewComponent

public TableViewComponent(IBasicEditingContext context)

Deprecated.

A constructor that sets the context.

Parameters:

context - the current editing context

Method Detail

setColumns

public void setColumns(TableViewColumn[] iColumns,
                       IBasicEditingContext context)

Deprecated.

Sets the table view column objects.

Parameters:

iColumns - an array of table view columns

context - the current editing context

getColumnSortedMode

protected com.sapportals.htmlb.enums.TableSortState getColumnSortedMode(int columnIndex,
                                                                        IBasicEditingContext context)

Deprecated.

Gets the sort state for each column during a header click event.

Parameters:

columnIndex - the column index number

context - the current editing context

Returns:

the table sort state

getColumns

protected TableViewColumns getColumns()

Deprecated.

Gets the table view columns array member.

Returns:

the table view columns

renderCell

public void renderCell(int row,
                       int column,
                       com.sapportals.htmlb.table.TableView tableView,
                       com.sapportals.htmlb.rendering.IPageContext rendererContext)

Deprecated.

Calls a renderer for each column. The implementation for the ICellRenderer interface.

Specified by:

renderCell in interface com.sapportals.htmlb.table.ICellRenderer

Parameters:

row - a row index

column - a column index

tableView - an instance of a table

rendererContext - a renderer context

setOnClientRowSelection

public void setOnClientRowSelection(String iOnRowSelJsFuncName,
                                    IBasicEditingContext context)

Deprecated.

Adds outside implementation during a select row event.

Parameters:

iOnRowSelJsFuncName - the name of a JavaScript function called during a select row event

context - the current editing context

createInputComponent

protected com.sapportals.htmlb.Component createInputComponent(IBasicEditingContext context)

Deprecated.

Description copied from class: AbstractInputComponent

Creates an input component.

Specified by:

createInputComponent in class AbstractInputComponent

Parameters:

context - the current editing context

Returns:

the component object

getDisplay

public com.sapportals.htmlb.Component getDisplay(IWizardContext context)

Deprecated.

Description copied from class: AbstractInputComponent

Gets the HTMLB component to display. If your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent. The default implementation returns null.

Specified by:

getDisplay in interface IWizardComponent

Overrides:

getDisplay in class AbstractInputComponent

Parameters:

context - the current wizard context

Returns:

the component, null if the component has no display

See Also:

IWizardComponent.getDisplay(com.sapportals.admin.wizardframework.api.IWizardContext)

getInputComponent

public com.sapportals.htmlb.table.TableView getInputComponent(IBasicEditingContext ctx)

Deprecated.

Gets the table view input component.

Parameters:

ctx - the current editing context

Returns:

the table view component

processInput

public void processInput(IWizardContext context)

Deprecated.

Description copied from class: AbstractInputComponent

Saves to the data model the values entered into wizard controls by the administrator. The default implementation calls the pane�s myProcessInput method, and then calls processInput on all the wizard components within the pane.
Implement this method to save to the data model the data from any HTMLB controls that you created in the pane.
This method is called after a user clicks a toolbar button, causing a new request to be made to the wizard component.

Specified by:

processInput in interface IWizardComponent

Specified by:

processInput in class AbstractInputComponent

Parameters:

context - the current wizard context

See Also:

IWizardComponent.processInput(com.sapportals.admin.wizardframework.api.IWizardContext)

doBeforeDisplay

public void doBeforeDisplay(IWizardContext context)

Deprecated.

Performs synchronization between the data model and the pane. The default implementation calls the pane�s myDoBeforeDisplay method, and then calls doBeforeDisplay on all the wizard components within the pane.
Override this method to change the standard user interface for a component.

Specified by:

doBeforeDisplay in interface IWizardComponent

Overrides:

doBeforeDisplay in class AbstractWizardComponent

Parameters:

context - the current wizard context

getTableState

public TableDataModel getTableState(IBasicEditingContext context)

Deprecated.

Gets the table data model object.

Parameters:

context - the current editing context

Returns:

the table data model

setSelectionMode

public void setSelectionMode(com.sapportals.htmlb.enums.TableSelectionMode selectionMode,
                             IBasicEditingContext context)

Deprecated.

Sets a selection mode.

Parameters:

selectionMode - a selection mode

context - the current editing context

isReadOnly

public Boolean isReadOnly(IBasicEditingContext context)

Deprecated.

Indicates whether the table view is in read-only mode.

Parameters:

context - the current editing context

Returns:

true if the table is in read-only mode, false if not

setReadOnly

public void setReadOnly(Boolean iReadOnly,
                        IBasicEditingContext context)

Deprecated.

Sets the table view to read-only mode.

Parameters:

iReadOnly - true sets the table to read-only mode false sets it to edit mode

context - the current editing context

setSelectAll

public void setSelectAll(Boolean iSelectAll,
                         IBasicEditingContext context)

Deprecated.

Selects all rows.

Parameters:

iSelectAll - true selects all rows false does not select all

context - the current editing context

setDeselectAll

public void setDeselectAll(Boolean iDeselectAll,
                           IBasicEditingContext context)

Deprecated.

Deselects all rows.

Parameters:

iDeselectAll - true deselects all false does not

context - the current editing context

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	-	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN