[jgb-cvs] jgb/src/dtd dtd.xml,1.26,1.27

[<fb...@us...>]

Update of /cvsroot/jgb/jgb/src/dtd
In directory sc8-pr-cvs1:/tmp/cvs-serv26304/src/dtd

Modified Files:
	dtd.xml 
Log Message:
* src/dtd/dtd.xml:
  Added documentation about new scrollable element which will be
  implemented shortly.


Index: dtd.xml
===================================================================
RCS file: /cvsroot/jgb/jgb/src/dtd/dtd.xml,v
retrieving revision 1.26
retrieving revision 1.27
diff -C2 -d -r1.26 -r1.27
*** dtd.xml	11 Jul 2003 15:10:09 -0000	1.26
--- dtd.xml	14 Jul 2003 18:03:12 -0000	1.27
***************
*** 136,139 ****
--- 136,140 ----
              <child repeat="once">list</child>
              <child repeat="once">sheet</child>
+             <child repeat="once">scrollable</child>
              <refgroup refgroup="external-calls-group" type="alternation" repeat="once"/>
          </childgroup>
***************
*** 2531,2534 ****
--- 2532,2655 ----
      &lt;<tag refelement="null"/> <attr refattr="null.class"/>="java.lang.String"&gt;
  &lt;/property&gt;
+ &ellipsis;
+         </example>
+     </element>
+     <element id="scrollable" group="group-control">
+         <name>scrollable</name>
+         <description>
+             <p>
+                 Modifies the first enclosing element by adding a scrollable
+                 area around the control.
+             </p>
+             <p>
+                 <see href="http://java.sun.com/j2se/1.3/docs/api/javax/swing/ScrollPaneConstants.html">ScrollPaneConstants</see>
+                 interface for more information about the valid values of the
+                 <attr refattr="scrollable.vsb_policy"/> and <attr refattr="scrollable.hsb_policy"/>
+                 attributes.
+             </p>
+         </description>
+         <attributes>
+             <refattribute refid="default.id" id="scrollable.id" required="false"/>
+             <attribute id="scrollable.vsb_policy" required="false">
+                 <name>vsb_policy</name>
+                 <description>
+                     <p>
+                         Determines the <em>Vertical Scroll Bar policy</em>,
+                         or when to show a vertical scroll bar.
+                     </p>
+                 </description>
+                 <values>
+                     <value id="scrollable.vsb_policy.always">
+                         <literal>always</literal>
+                         <description>
+                             <p>
+                                 Always show a vertical scrollbar.
+                             </p>
+                         </description>
+                     </value>
+                     <value id="scrollable.vsb_policy.as_needed" default="true">
+                         <literal>as_needed</literal>
+                         <description>
+                             <p>
+                                 Show a vertical scrollbar if the view's height
+                                 is larger than the available display height.
+                             </p>
+                         </description>
+                     </value>
+                     <value id="scrollable.vsb_policy.never">
+                         <literal>never</literal>
+                         <description>
+                             <p>
+                                 Never show a vertical scrollbar.
+                             </p>
+                         </description>
+                     </value>
+                 </values>
+             </attribute>
+             <attribute id="scrollable.hsb_policy" required="false">
+                 <name>hsb_policy</name>
+                 <description>
+                     <p>
+                         Determines the
+                         <em>Horizontal Scroll Bar policy</em>,
+                         or when to show a horizontal scroll bar.
+                     </p>
+                 </description>
+                 <values>
+                     <value id="scrollable.hsb_policy.always">
+                         <literal>always</literal>
+                         <description>
+                             <p>
+                                 Always show a horizontal scrollbar.
+                             </p>
+                         </description>
+                     </value>
+                     <value id="scrollable.hsb_policy.as_needed" default="true">
+                         <literal>as_needed</literal>
+                         <description>
+                             <p>
+                                 Show a horizontal scrollbar if the view's width
+                                 is larger than the available display width.
+                             </p>
+                         </description>
+                     </value>
+                     <value id="scrollable.hsb_policy.never">
+                         <literal>never</literal>
+                         <description>
+                             <p>
+                                 Never show a horizontal scrollbar.
+                             </p>
+                         </description>
+                     </value>
+                 </values>
+             </attribute>
+         </attributes>
+         <children>
+             <refgroup refgroup="child-group" repeat="once" type="sequence"/>
+         </children>
+         <example>
+ &ellipsis;
+ &lt;!--
+     Add a text field that is 80 caracters wide by 20 lines high.  Add it in
+     a scrollable region, so that it does not use all of the available space.
+ 
+     Using the definitions here, it will be possible to individually address
+     the scroll pane and the text field itself, using the appropriate IDs.
+ --&gt;
+ &lt;<tag refelement="scrollable"/> <attr refattr="scrollable.id"/>="comments_scroller" <attr refattr="scrollable.vsb_policy"/>="always" <attr refattr="scrollable.hsb_policy"/>="as needed"&gt;
+     &lt;
+  <tag refelement="textfield"/> <attr refattr="textfield.id"/>="comments_field" <attr refattr="textfield.columns"/>="80" <attr refattr="textfield.rows"/>="20"&gt;
+         &ellipsis;
+     &lt;/textfield&gt;
+ &lt;/scrollable&gt;
+ &ellipsis;
+ 
+ &lt;!--
+     Here, we set the columnHeaderView property of the scroll pane itself.
+ --&gt;
+ &lt;<tag refelement="property"/> <attr refattr="property.refid"/>="comments_scroller" <attr refattr="property.name"/>="columnHeaderView"&gt;
+     &lt;<tag refelement="ref"/> <attr refattr="ref.refid"/>="&ellipsis;"/&gt;
+ &lt;/property&gt;
+ 
  &ellipsis;
          </example>