|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISearchResultsOptionsManager
Implementations provide management for search results options
Field Summary | |
---|---|
static String |
KEY_COLUMN_DISPLAY
This search result option controls which table columns are visible. |
static String |
KEY_COLUMN_WIDTH
This search result option controls the widths of the displayed columns. |
static String |
KEY_INITIAL_PAGE_SIZE
This search result option controls how many rows are displayed on each page of search results. |
static String |
KEY_INITIAL_SORT_ASCENDING
This search result option controls whether the search result data is sorted in ascending or descending order. |
static String |
KEY_INITIAL_SORT_BY
This search result option controls which column is used to sort the search results The value must be the id of a sortable column. |
Method Summary | |
---|---|
String |
getColumnWidthsPreference()
Return the column widths preference. |
String[] |
getDisplayColumnsPreference()
Return the display column preference. |
int |
getInitialPageSize()
Returns page size for search results display |
boolean |
getInitialSortAscendingPreference()
Return the initialSortBy preference. |
String |
getInitialSortByPreference()
Return the initialSortBy preference. |
void |
setColumnWidthsPreference(String columnWidths)
Sets the column widths preference. |
void |
setDisplayColumnsPreference(String[] columnDisplay)
Sets the display column preference. |
void |
setInitialPageSize(int pageSize)
Sets initialPageSize preference |
void |
setInitialSortAscendingPreference(boolean ascending)
Sets initialSortBy preference. |
void |
setInitialSortByPreference(String sortBy)
Sets initial sortBy preference |
Field Detail |
---|
static final String KEY_INITIAL_SORT_BY
static final String KEY_INITIAL_SORT_ASCENDING
static final String KEY_COLUMN_DISPLAY
static final String KEY_COLUMN_WIDTH
static final String KEY_INITIAL_PAGE_SIZE
Method Detail |
---|
String[] getDisplayColumnsPreference()
void setDisplayColumnsPreference(String[] columnDisplay)
String getColumnWidthsPreference()
void setColumnWidthsPreference(String columnWidths)
String getInitialSortByPreference()
void setInitialSortByPreference(String sortBy)
sortBy
- the column id to sort byboolean getInitialSortAscendingPreference()
void setInitialSortAscendingPreference(boolean ascending)
ascending
- true for ascending sort, false for descening sortint getInitialPageSize()
void setInitialPageSize(int pageSize)
pageSize
- the number of rows to display on each page of results
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |