|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.service.util.TableInfo.Column
public class TableInfo.Column
Inner class that represents all the information about a table column -- its name, column heading, the corresponding sort property, the current sort direction, and the position of this column's property relative to others when doing multi-column sorting.
Method Summary | |
---|---|
protected int |
direction()
Get the direction code for this entry, but in a way that is not accessible as a Java bean getter since only the enclosing class should ever be dealing with integer direction codes, which exist only for efficiency of the implementation. |
java.lang.String |
getHeading()
Return the display name (column heading) for this column entry. |
java.lang.String |
getName()
Return the name for this column entry. |
java.lang.String |
getProperty()
Return the property used to sort on this column |
java.lang.String |
getSortDirection()
Return the direction string for this entry, which will be "ascending", "descending", or "none". |
int |
getSortIndex()
Return the relative index for this column. |
int |
getSortPosition()
Return the relative position for this entry. |
java.lang.String |
getSortString()
Return a string of the form [+/-]propertyName |
void |
setSortDirection(java.lang.String pDirectionType)
Set the direction for this entry. |
protected void |
useDirection(int pDirection)
Set the direction code for this entry, but in a way that is not accessible as a Java bean setter since only the enclosing class should ever be dealing with integer direction codes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.String getName()
public java.lang.String getHeading()
public java.lang.String getProperty()
public int getSortIndex()
For example, if a TableColumns object has three columns called "Name", "Age", and "Salary", and the table is being sorted first on salary and then on age, the index for Name would be -1 (no sort), the index for Salary would be 0 (indicating that it is the primary sort key), and the index for Salary would be 1 (indicating that it is the secondary sort key after Salary. Note that the index values are completely independent of the order in which Columns appear in the TableColumns object, and of the order in which they are rendered on the page.
public int getSortPosition()
public java.lang.String getSortDirection()
public void setSortDirection(java.lang.String pDirectionType)
protected int direction()
protected void useDirection(int pDirection)
public java.lang.String getSortString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |