com.sas.servlet.tbeans.navigationbar
Interface ColumnNavigationInterface

All Superinterfaces:

BaseNavigationInterface, URLTemplateViewInterface

All Known Implementing Classes:

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

public interface ColumnNavigationInterface
extends BaseNavigationInterface

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

A page is the current set of columns from startColumn to endColumn that will be displayed. The columnPageSize determines how many columns to display. So endColumn minus startColumn should equal columnPageSize.

Method Summary

abstract void	firstColumn() Navigates to the first column.
abstract int	getColumnCount() Returns the number of columns.
abstract int	getColumnPageSize() Returns the number of columns to display per page.
abstract int	getEndColumn() Returns the end column of the current page of displayed columns.
abstract java.lang.String	getFormName() Gets the name of the form that is to be submitted when to gotoColumn action is executed.
abstract int	getStartColumn() Returns the start column of the current page of displayed columns.
abstract void	gotoColumn(int column) Navigates to the given column.
abstract boolean	isFirstColumnSupported() Determines whether navigation to the first column is supported.
abstract boolean	isGotoColumnSupported() Determines whether navigation to jump to a specified column is supported.
abstract boolean	isLastColumnSupported() Determines whether navigation to the last column is supported.
abstract boolean	isNextColumnSupported() Determines whether navigation to the next column is supported.
abstract boolean	isPageBackwardColumnsSupported() Determines whether navigation back a page of columns is supported.
abstract boolean	isPageForwardColumnsSupported() Determines whether navigation forward a page of columns is supported.
abstract boolean	isPreviousColumnSupported() Determines whether navigation to the previous column is supported.
abstract void	lastColumn() Navigates to the last column.
abstract void	nextColumn() Navigates to the next column.
abstract void	pageBackwardColumns() Navigates backward a page of columns.
abstract void	pageForwardColumns() Navigates forward a page of columns.
abstract void	previousColumn() Navigates to the previous column.
abstract void	setColumnPageSize(int size) Sets the number of columns to display per page.

Methods inherited from interface com.sas.actionprovider.URLTemplateViewInterface

getURLTemplate, setURLTemplate

Method Detail

isFirstColumnSupported

boolean isFirstColumnSupported()

Determines whether navigation to the first column is supported.

Returns:

true if navigation to the first column is supported

See Also:

firstColumn()

isPageBackwardColumnsSupported

boolean isPageBackwardColumnsSupported()

Determines whether navigation back a page of columns is supported.

Returns:

true if navigation back a page of columns is supported

See Also:

pageBackwardColumns()

isPreviousColumnSupported

boolean isPreviousColumnSupported()

Determines whether navigation to the previous column is supported.

Returns:

true if navigation to the previous column is supported

See Also:

previousColumn()

isNextColumnSupported

boolean isNextColumnSupported()

Determines whether navigation to the next column is supported.

Returns:

true if navigation to the next column is supported

See Also:

nextColumn()

isPageForwardColumnsSupported

boolean isPageForwardColumnsSupported()

Determines whether navigation forward a page of columns is supported.

Returns:

true if navigation forward a page of columns is supported

See Also:

pageForwardColumns()

isLastColumnSupported

boolean isLastColumnSupported()

Determines whether navigation to the last column is supported.

Returns:

true if navigation to the last column is supported

See Also:

lastColumn()

isGotoColumnSupported

boolean isGotoColumnSupported()

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

Returns:

true if navigation to the goto column is supported

See Also:

gotoColumn(int)

firstColumn

void firstColumn()

Navigates to the first column.

Throws:

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

See Also:

isFirstColumnSupported()

pageBackwardColumns

void pageBackwardColumns()

Navigates backward a page of columns.

Throws:

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

See Also:

isPageBackwardColumnsSupported()

previousColumn

void previousColumn()

Navigates to the previous column.

Throws:

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

See Also:

isPreviousColumnSupported()

nextColumn

void nextColumn()

Navigates to the next column.

Throws:

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

See Also:

isNextColumnSupported()

pageForwardColumns

void pageForwardColumns()

Navigates forward a page of columns.

Throws:

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

See Also:

isPageForwardColumnsSupported()

lastColumn

void lastColumn()

Navigates to the last column.

Throws:

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

See Also:

isLastColumnSupported()

gotoColumn

void gotoColumn(int column)

Navigates to the given column.

Parameters:

column - the column index

Throws:

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

See Also:

isGotoColumnSupported()

getStartColumn

int getStartColumn()

Returns the start column of the current page of displayed columns.

Returns:

the start column of the current page of displayed columns

getEndColumn

int getEndColumn()

Returns the end column of the current page of displayed columns.

Returns:

the end column of the current page of displayed columns

getColumnCount

int getColumnCount()

Returns the number of columns.

Returns:

the number of columns

getColumnPageSize

int getColumnPageSize()

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

Returns:

the number of columns to display per page

setColumnPageSize

void setColumnPageSize(int size)

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

Parameters:

size - the number of columns to display per page

getFormName

java.lang.String getFormName()

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

Returns:

the name of the form to be submitted