e4s.html.list
Interface E4SortedList_Intf

All Known Implementing Classes:

E4DirEntry, E4SortedListItem

public interface E4SortedList_Intf

Interface for E4SortedList data entry elements.

See Also:

E4SortedList

Field Summary

static int	PRIMARY_SORT_BOTTOM
static int	PRIMARY_SORT_MIDDLE
static int	PRIMARY_SORT_TOP

Method Summary

boolean	canSelect() In the case, that an action method is defined for the header, check if this element can be selected.
int	compareTo(E4SortedList_Intf element, int column) Compare a particular column with another element.
E4Color	getBgColor() Get the background color for this row.
java.lang.String	getData4Parameter(int column) Get the data to be used as parameter for the specified column.
int	getPrimarySort() Get the primary sort value.
java.lang.String	toHtml(int column, E4SortedListColumn coldef, E4ServletImplementation_Intf servlet) Get the data formatted for display for the specified column.

Field Detail

PRIMARY_SORT_TOP

static final int PRIMARY_SORT_TOP

See Also:

Constant Field Values

PRIMARY_SORT_MIDDLE

static final int PRIMARY_SORT_MIDDLE

See Also:

Constant Field Values

PRIMARY_SORT_BOTTOM

static final int PRIMARY_SORT_BOTTOM

See Also:

Constant Field Values

Method Detail

compareTo

int compareTo(E4SortedList_Intf element,
              int column)

Compare a particular column with another element. This enables the e4s to support a sorting functionality on those lists.

Parameters:

element - the second element to compare with

column - column count starts at 0, and is 1 below the number specified on the Constructor

Returns:

The result is a negative integer if this Object precedes the argument Object. The result is a positive integer if this Object follows the argument Object. The result is zero if the Objects are equal.

toHtml

java.lang.String toHtml(int column,
                        E4SortedListColumn coldef,
                        E4ServletImplementation_Intf servlet)
                        throws java.lang.Exception

Get the data formatted for display for the specified column.

Parameters:

column - the specified column, starting with 0

Returns:

a String representing the content for display (including all tags)

Throws:

java.lang.Exception

getData4Parameter

java.lang.String getData4Parameter(int column)

Get the data to be used as parameter for the specified column.

Parameters:

column - the specified column, starting with 0

Returns:

a String representing the data (including no tags)

getBgColor

E4Color getBgColor()

Get the background color for this row.

Returns:

the backgroundcolor or null if default shall be used.

getPrimarySort

int getPrimarySort()

Get the primary sort value. The primary sort mechanism is used to establish rows that apear explicit on the top of the table always (PRIMARY_SORT_TOP) or at the bottom of the table (PRIMARY_SORT_BOTTOM. All other rows must have a value of PRIMARY_SORT_MIDDLE. Sorting also works within the groupings.

Returns:

the value of the primary sort.

See Also:

PRIMARY_SORT_TOP, PRIMARY_SORT_MIDDLE, PRIMARY_SORT_BOTTOM

canSelect

boolean canSelect()

In the case, that an action method is defined for the header, check if this element can be selected.

Returns:

true if this element can be selected.