summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMatti Tahvonen <matti.tahvonen@itmill.com>2011-05-04 07:52:01 +0000
committerMatti Tahvonen <matti.tahvonen@itmill.com>2011-05-04 07:52:01 +0000
commit125fb56e4bb2e6f0b850278006714912018db65f (patch)
tree09b06ff1f7828440c8e701a19c9808c2fcb655e7 /src
parent3fb9e26a5cf632723d646e5d72e343b9751d08fa (diff)
downloadvaadin-framework-125fb56e4bb2e6f0b850278006714912018db65f.tar.gz
vaadin-framework-125fb56e4bb2e6f0b850278006714912018db65f.zip
Enhanced javadoc
svn changeset:18623/svn branch:6.6
Diffstat (limited to 'src')
-rw-r--r--src/com/vaadin/ui/Table.java11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/com/vaadin/ui/Table.java b/src/com/vaadin/ui/Table.java
index a76153f772..93987cff35 100644
--- a/src/com/vaadin/ui/Table.java
+++ b/src/com/vaadin/ui/Table.java
@@ -3139,7 +3139,16 @@ public class Table extends AbstractSelect implements Action.Container,
}
/**
- * Returns the list of items on the current page
+ * Returns item identifiers of the items which are currently rendered on the
+ * client.
+ * <p>
+ * Note, that some due to historical reasons the name of the method is bit
+ * misleading. Some items may be partly or totally out of the viewport of
+ * the table's scrollable area. Actully detecting rows which can be actually
+ * seen by the end user may be problematic due to the client server
+ * architecture. Using {@link #getCurrentPageFirstItemId()} combined with
+ * {@link #getPageLength()} may produce good enough estimates in some
+ * situations.
*
* @see com.vaadin.ui.Select#getVisibleItemIds()
*/