com.sas.servlet.tbeans.navigationbar
Interface RowNavigationInterface

All Superinterfaces:

AccurateRowCountInterface, BaseNavigationInterface, URLTemplateViewInterface

All Known Implementing Classes:

AbstractBaseTableView, BaseOLAPTableView, BaseTableView, OLAPTableView, TableView, TableView, TableView

public interface RowNavigationInterface
extends BaseNavigationInterface, AccurateRowCountInterface

Defines the interface to be implemented by a TranformationBean which will use a NavigationBar to navigate through the rows of the TranformationBean's model. For example, a TableView TranformationBean's model contains rows. So a TableView TranformationBean should implement this interface to allow row navigation through its model.

A page is the current set of rows from startRow to endRow that will be displayed. The rowPageSize determines how many rows to display. So endRow minus startRow should equal rowPageSize.

Method Summary

void	firstRow() Navigates to the first row.
int	getEndRow() Returns the end row of the current segment of displayed rows.
java.lang.String	getFormName() Gets the name of the form that is to be submitted when to gotoRow action is executed.
int	getRowCount() Returns the number of rows.
int	getRowPageSize() Returns the number of rows to display per page.
int	getStartRow() Returns the start row of the current segment of displayed rows.
void	gotoRow(int row) Navigates to the given row.
boolean	isFirstRowSupported() Determines whether navigation to the first row is supported.
boolean	isGotoRowSupported() Determines whether navigation to jump to a specified row is supported.
boolean	isLastRowSupported() Determines whether navigation to the last row is supported.
boolean	isNextRowSupported() Determines whether navigation to the next row is supported.
boolean	isPageBackwardRowsSupported() Determines whether navigation back a page of rows is supported.
boolean	isPageForwardRowsSupported() Determines whether navigation forward a page of rows is supported.
boolean	isPreviousRowSupported() Determines whether navigation to the previous row is supported.
void	lastRow() Navigates to the last row.
void	nextRow() Navigates to the next row.
void	pageBackwardRows() Navigates backward a page of rows.
void	pageForwardRows() Navigates forward a page of rows.
void	previousRow() Navigates to the previous row.
void	setRowPageSize(int size) Sets the number of rows to display per page.

Methods inherited from interface com.sas.actionprovider.URLTemplateViewInterface

getURLTemplate, setURLTemplate

Methods inherited from interface com.sas.table.AccurateRowCountInterface

isAccurateRowCountAvailable

Method Detail

isFirstRowSupported

boolean isFirstRowSupported()

Determines whether navigation to the first row is supported.

Returns:

true if navigation to the first row is supported

See Also:

firstRow()

isPageBackwardRowsSupported

boolean isPageBackwardRowsSupported()

Determines whether navigation back a page of rows is supported.

Returns:

true if navigation back a page of rows is supported

See Also:

pageBackwardRows()

isPreviousRowSupported

boolean isPreviousRowSupported()

Determines whether navigation to the previous row is supported.

Returns:

true if navigation to the previous row is supported

See Also:

previousRow()

isNextRowSupported

boolean isNextRowSupported()

Determines whether navigation to the next row is supported.

Returns:

true if navigating to the next row is supported

See Also:

nextRow()

isPageForwardRowsSupported

boolean isPageForwardRowsSupported()

Determines whether navigation forward a page of rows is supported.

Returns:

true if navigation forward a page of rows is supported

See Also:

pageForwardRows()

isLastRowSupported

boolean isLastRowSupported()

Determines whether navigation to the last row is supported.

Returns:

true if navigation to the last row is supported

See Also:

lastRow()

isGotoRowSupported

boolean isGotoRowSupported()

Determines whether navigation to jump to a specified row is supported.

Returns:

true if navigation to the goto row is supported

See Also:

gotoRow(int)

firstRow

void firstRow()

Navigates to the first row.

Throws:

java.lang.UnsupportedOperationException - Thrown if isFirstRowSupported() returns false

See Also:

isFirstRowSupported()

pageBackwardRows

void pageBackwardRows()

Navigates backward a page of rows.

Throws:

java.lang.UnsupportedOperationException - Thrown if isPageBackwardRowsSupported() returns false

See Also:

isPageBackwardRowsSupported()

previousRow

void previousRow()

Navigates to the previous row.

Throws:

java.lang.UnsupportedOperationException - Thrown if isPreviousRowSupported() returns false

See Also:

isPreviousRowSupported()

nextRow

void nextRow()

Navigates to the next row.

Throws:

java.lang.UnsupportedOperationException - Thrown if isNextRowSupported() returns false

See Also:

isNextRowSupported()

pageForwardRows

void pageForwardRows()

Navigates forward a page of rows.

Throws:

java.lang.UnsupportedOperationException - Thrown if isPageForwardRowsSupported() returns false

See Also:

isPageForwardRowsSupported()

lastRow

void lastRow()

Navigates to the last row.

Throws:

java.lang.UnsupportedOperationException - Thrown if isLastRowSupported() returns false

See Also:

isLastRowSupported()

gotoRow

void gotoRow(int row)

Navigates to the given row.

Parameters:

row - the row index

Throws:

java.lang.UnsupportedOperationException - Thrown if isGotoRowSupported() returns false

See Also:

isGotoRowSupported()

getStartRow

int getStartRow()

Returns the start row of the current segment of displayed rows.

Returns:

the start row of the current segment of displayed rows

getEndRow

int getEndRow()

Returns the end row of the current segment of displayed rows.

Returns:

the end row of the current segment of displayed rows

getRowCount

int getRowCount()

Returns the number of rows. If isAccurateRowCountAvailable returns false, then rowCount is the current number of known (read) rows.

Returns:

the number of rows

getRowPageSize

int getRowPageSize()

Returns the number of rows to display per page. Returns -1 if all rows are to be displayed.

Returns:

the number of rows to display per page

setRowPageSize

void setRowPageSize(int size)

Sets the number of rows to display per page. Set to -1 if all rows are to be displayed.

Parameters:

size - the number of rows to display per page

getFormName

java.lang.String getFormName()

Gets the name of the form that is to be submitted when to gotoRow action is executed. This is only needed for the gotoRow action.

Returns:

the name of the form to be submitted