morciuch 2002/08/20 10:39:35
Modified: xdocs portlet_config_common.xml
Log:
Added documentation for parameter presentation styles (see Bugzilla issue 11697)
Revision Changes Path
1.8 +53 -0 jakarta-jetspeed/xdocs/portlet_config_common.xml
Index: portlet_config_common.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/portlet_config_common.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- portlet_config_common.xml 17 Jul 2002 06:29:31 -0000 1.7
+++ portlet_config_common.xml 20 Aug 2002 17:39:35 -0000 1.8
@@ -207,6 +207,15 @@
<td>boolean</td>
<td>Only <tt>true</tt> or <tt>false</tt> are allowed as a value for
this parameter</td>
</tr>
+ <tr>
+ <td>style</td>
+ <td>Designates the parameter as having a custom presentation style. The
presentation style name is defined as value of
+ [parameter name].style parameter. For example, if parameter named
"symbols" is designated with type="style", then the style
+ name is defined as value of "symbols.style" hidden parameter. Each
parameter designated as having a custom style,
+ will be displayed in the default portlet customizer using the defined
parameter style. For sample parameter styles and
+ instructions on how to develop your own, see javadoc for
<code>org.apache.jetspeed.modules.parameters</code> package.
+ See below for example registry entry.</td>
+ </tr>
</table>
</td>
</tr>
@@ -454,6 +463,50 @@
</meta-info>
<security role=""/>
</parameter>
+</portlet-entry>
+]]></source>
+ <p>
+ <center>Portal Entry using Parameter Styles</center>
+ </p>
+<source><![CDATA[
+<portlet-entry name="StockQuotePortlet" hidden="false" type="instance"
application="false">
+ <meta-info>
+ <title></title>
+ <description></description>
+ </meta-info>
+ <parameter name="sort" value="Symbol" type="style"
+ hidden="false">
+ <meta-info>
+ <title>Sort</title>
+ <description>Column to sort by</description>
+ </meta-info>
+ </parameter>
+ <parameter name="sort.style" value="ListBox" hidden="true"/>
+ <parameter name="sort.style.items" value="Symbol,Volume,PChange" hidden="true"/>
+ <parameter name="columns"
+ value="Symbol,Quote,Date,Time,Change,PChange,Open,High,Low,Volume"
+ type="style" hidden="false">
+ <meta-info>
+ <title>Columns</title>
+ <description>Columns to display</description>
+ </meta-info>
+ </parameter>
+ <parameter name="columns.style.items"
+ value="Symbol,Quote,Date,Time,Change,PChange,Open,High,Low,Volume"
+ hidden="true"/>
+ <parameter name="columns.style.layout" value="$eastwest"
+ hidden="true"/>
+ <parameter name="columns.style" value="CheckBoxGroup"
+ hidden="true"/>
+ <parameter name="symbols"
+ value="MSFT,EMC,SUNW,ORCL,IBM"
+ type="style" hidden="false">
+ <meta-info>
+ <title>Symbols</title>
+ <description>List of comma-separated stock symbols</description>
+ </meta-info>
+ </parameter>
+ <parameter name="symbols.style" value="TextArea" hidden="true"/>
</portlet-entry>
]]></source>
</section>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
