aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatti Tahvonen <matti.tahvonen@itmill.com>2010-11-04 13:46:30 +0000
committerMatti Tahvonen <matti.tahvonen@itmill.com>2010-11-04 13:46:30 +0000
commit96e8b4347410a5e258caa6eb62058ffcb77b840d (patch)
tree7272099ffe656e1e712558526de8e911640bac7f
parent895b709ce96e33efe2bc468c42e91608c66a3f3e (diff)
downloadvaadin-framework-96e8b4347410a5e258caa6eb62058ffcb77b840d.tar.gz
vaadin-framework-96e8b4347410a5e258caa6eb62058ffcb77b840d.zip
javadocs
svn changeset:15860/svn branch:6.5
-rw-r--r--src/com/vaadin/ui/HorizontalSplitPanel.java18
-rw-r--r--src/com/vaadin/ui/VerticalSplitPanel.java17
2 files changed, 35 insertions, 0 deletions
diff --git a/src/com/vaadin/ui/HorizontalSplitPanel.java b/src/com/vaadin/ui/HorizontalSplitPanel.java
index 8675f727d6..6554784903 100644
--- a/src/com/vaadin/ui/HorizontalSplitPanel.java
+++ b/src/com/vaadin/ui/HorizontalSplitPanel.java
@@ -2,6 +2,24 @@ package com.vaadin.ui;
import com.vaadin.terminal.gwt.client.ui.VSplitPanelHorizontal;
+/**
+ * A horizontal split panel contains two components and lays them horizontally.
+ * The first component is on the left side.
+ *
+ * <pre>
+ *
+ * +---------------------++----------------------+
+ * | || |
+ * | The first component || The second component |
+ * | || |
+ * +---------------------++----------------------+
+ *
+ * ^
+ * |
+ * the splitter
+ *
+ * </pre>
+ */
@ClientWidget(VSplitPanelHorizontal.class)
public class HorizontalSplitPanel extends SplitPanel {
public HorizontalSplitPanel() {
diff --git a/src/com/vaadin/ui/VerticalSplitPanel.java b/src/com/vaadin/ui/VerticalSplitPanel.java
index d0ae66b2a2..d198813ef9 100644
--- a/src/com/vaadin/ui/VerticalSplitPanel.java
+++ b/src/com/vaadin/ui/VerticalSplitPanel.java
@@ -2,6 +2,23 @@ package com.vaadin.ui;
import com.vaadin.terminal.gwt.client.ui.VSplitPanelVertical;
+/**
+ * A vertical split panel contains two components and lays them vertically. The
+ * first component is above the second component.
+ *
+ * <pre>
+ * +--------------------------+
+ * | |
+ * | The first component |
+ * | |
+ * +==========================+ <-- splitter
+ * | |
+ * | The second component |
+ * | |
+ * +--------------------------+
+ * </pre>
+ *
+ */
@ClientWidget(VSplitPanelVertical.class)
public class VerticalSplitPanel extends SplitPanel {
public VerticalSplitPanel() {