Documentation

[gpl/argeo-slc.git] / org.argeo.slc.webapp / src / main / webapp / argeo-ria-src / class / org / argeo / ria / components / ViewPane.js

diff --git a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/components/ViewPane.js b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/components/ViewPane.js
index e04970c4388420c54df81b805e1dcc7c55a6950b..a239f91a41e32d846f6db0cd63e6cbf89e16df6e 100644 (file)
--- a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/components/ViewPane.js
+++ b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-src/class/org/argeo/ria/components/ViewPane.js
@@ -143,7 +143,12 @@ qx.Class.define("org.argeo.ria.components.ViewPane",
                        this.add(this.guiContent, {flex:1});
                }
        },
-               
+       /**
+        * Adds a graphical component too the header of the view pane.
+        * It is added as "center" in the dock layout, and will override the view pane title label.
+        * For example, you can add your own title, or add a switch, or buttons, etc.
+        * @param component {qx.ui.core.Widget} The graphical component to add.
+        */
        addHeaderComponent : function(component){
                this.header.setPadding(4);
                this.header.add(component, {edge:"center"});