svn commit: r671659 - /myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java

[sk...@apache.org]

Author: skitching
Date: Wed Jun 25 14:09:20 2008
New Revision: 671659

URL: http://svn.apache.org/viewvc?rev=671659&view=rev
Log:
Add javadoc only

Modified:
    myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java

Modified: myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java?rev=671659&r1=671658&r2=671659&view=diff
==============================================================================
--- myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java (original)
+++ myfaces/tomahawk/trunk/core/src/main/java/org/apache/myfaces/component/html/ext/AbstractHtmlDataTable.java Wed Jun 25 14:09:20 2008
@@ -1096,6 +1096,17 @@
         return v != null ? v.booleanValue() : DEFAULT_SORTASCENDING;
     }
 
+    /**
+     * The name of a javabean property on which the table is sorted.
+     * <p>
+     * The datamodel should contain objects that have this property;
+     * reflection will be used to sort the datamodel on that property
+     * using the default comparator for that type. 
+     * <p>
+     * This value is part of the component state. However it is not
+     * directly settable by users; instead it is set by other components
+     * such as a CommandSortHeader.
+     */
     public void setSortProperty(String sortProperty)
     {
         _sortProperty = sortProperty;