|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.stratelia.webactiv.util.datapaginator.WADataPaginatorHeader
public class WADataPaginatorHeader
The WADataPaginatorHeader is used by presentation components such as the ViewGenerator to help
them manage their user interface. The hold all information that are needed by the rendering
object to present table headers, namely:
This object is actually a collection of FieldDescriptor
objects. One thus first creates
an empty WADataPaginatorHeader, and then call the addField(java.lang.String, java.lang.String, int, java.lang.String)
method as many times as there
are columns to display.
The rendering process, on the other hand, will get this list of fields back, and will, depending
on the flags returned by the #getFlags()
routine, output the header information of each
field.
Field Summary | |
---|---|
static int |
FLAGS_ASCENDING
ascending flag. |
static int |
FLAGS_SORT_KEY
sort key. |
static int |
FLAGS_SORTABLE
sortable flag. |
Constructor Summary | |
---|---|
WADataPaginatorHeader()
|
Method Summary | |
---|---|
void |
addField(String field,
String displayName,
int flags,
String routingAddress)
This method adds a field at the end of list of fields for this header |
int |
getFieldCount()
This method retuns the count of fields in this header. |
String |
getFieldDisplayName(int idx)
|
String |
getFieldName(int idx)
|
String |
getFieldRoutingAddress(int idx)
|
String |
getSortKey()
|
int |
getSortKeyIndex()
|
boolean |
isFieldAscending(int idx)
|
boolean |
isFieldDescending(int idx)
|
boolean |
isFieldSortable(int idx)
|
void |
toggleFieldSortOrder(int idx)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int FLAGS_SORTABLE
public static final int FLAGS_ASCENDING
public static final int FLAGS_SORT_KEY
Constructor Detail |
---|
public WADataPaginatorHeader()
Method Detail |
---|
public int getFieldCount()
addField(java.lang.String, java.lang.String, int, java.lang.String)
succeeded
#addField()
public void addField(String field, String displayName, int flags, String routingAddress)
field
- The internal field name, presumably meaningful to the DataPaginator.displayName
- The display name of the field, that would typically be output on the
rendering device by presentation objects (in short, thisis the label of the column)flags
- A combination of flags suchs as FLAGS_SORTABLE
, FLAGS_ASCENDING
and so on.routingAddress
- A specification of the callback method used when the user selects this
field If this value is NULL, the rendering device uses whatever is suitable for its default
behaviour. If this value is empty, the rendering device should NOT associate a routing address
to this field. In other words, this field will not be 'clickable'. In all other cases, the
rendering process will use the value. Typically, one would use an URL as a routingAddress.public void toggleFieldSortOrder(int idx)
public boolean isFieldSortable(int idx)
public boolean isFieldAscending(int idx)
public boolean isFieldDescending(int idx)
public String getFieldRoutingAddress(int idx)
public String getSortKey()
public int getSortKeyIndex()
public String getFieldDisplayName(int idx)
public String getFieldName(int idx)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |