wt.templateutil.table
Class ColumnSortService

java.lang.Object
  wt.templateutil.table.ColumnSortService

public class ColumnSortService

extends Object

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release.

This class tracks a user's preferences for which column to use for sorting a table and the order in which sorting should be done. It updates the user's preference based on the formData of the current page and retrieves preference information when sorting is to be done.

Supported API: true

Extendable: false

Field Summary

private static String	AMPERSTAND Deprecated.
private static String	COLUMN Deprecated.
static String	DELIM Deprecated.
static String	DOWN Deprecated.
private static String	EQUALS Deprecated.
private static String	FORWARD_SLASH Deprecated.
private static String	ISASCENDING Deprecated.
static String	SORT_BY Deprecated.
private static String	SORTED_COLUMN_PREFIX Deprecated.
private HashMap	sortMap Deprecated.
private HTTPState	state Deprecated.
private static String	TABLE Deprecated.
private static String[]	TOKENS Deprecated.
static String	UP Deprecated.

Constructor Summary

ColumnSortService(HTTPState state)
Deprecated.

Method Summary

String	getCommandString(String tableName, String columnName) Deprecated.
String	getQueryString(String tableName, String columnName) Deprecated.
String	getSortedColumnName(String tableName) Deprecated.
boolean	isColumnSorted(String tableName, String columnName) Deprecated.
boolean	isSortAscending(String tableName, String columnName) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

DELIM

public static final String DELIM

Deprecated.

See Also:

Constant Field Values

TABLE

private static final String TABLE

Deprecated.

See Also:

Constant Field Values

COLUMN

private static final String COLUMN

Deprecated.

See Also:

Constant Field Values

ISASCENDING

private static final String ISASCENDING

Deprecated.

See Also:

Constant Field Values

TOKENS

private static final String[] TOKENS

Deprecated.

SORT_BY

public static final String SORT_BY

Deprecated.

See Also:

Constant Field Values

UP

public static final String UP

Deprecated.

See Also:

Constant Field Values

DOWN

public static final String DOWN

Deprecated.

See Also:

Constant Field Values

AMPERSTAND

private static final String AMPERSTAND

Deprecated.

See Also:

Constant Field Values

EQUALS

private static final String EQUALS

Deprecated.

See Also:

Constant Field Values

FORWARD_SLASH

private static final String FORWARD_SLASH

Deprecated.

See Also:

Constant Field Values

SORTED_COLUMN_PREFIX

private static final String SORTED_COLUMN_PREFIX

Deprecated.

See Also:

Constant Field Values

state

private HTTPState state

Deprecated.

sortMap

private HashMap sortMap

Deprecated.

Constructor Detail

ColumnSortService

public ColumnSortService(HTTPState state)
                  throws WTException

Deprecated.

Constructs an instance of the ColumnSortService and updates the user's sorting preferences based on the form data of the current page.

Method Detail

isColumnSorted

public boolean isColumnSorted(String tableName,
                              String columnName)

Deprecated.

isSortAscending

public boolean isSortAscending(String tableName,
                               String columnName)

Deprecated.

Returns true if the given column should be sorted in ascending order, false if descending

Parameters:

tableName - name of the table as returned by the HTMLComponent.getName() method

columnName - name of the column by which the table is sorted

Supported API: true

getQueryString

public String getQueryString(String tableName,
                             String columnName)

Deprecated.

getCommandString

public String getCommandString(String tableName,
                               String columnName)

Deprecated.

getSortedColumnName

public String getSortedColumnName(String tableName)

Deprecated.

Gets the name of the column by which a table should be sorted

Parameters:

tableName - name of the table as returned by the HTMLComponent.getName() method

Supported API: true