Author: SeanRogers Date: 2010-12-22 02:13:10 -0500 (Wed, 22 Dec 2010) New Revision: 20740 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Drag_and_drop.xml modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml Log: Draft of drag and drop RFPL-974 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2010-12-22 02:44:21 UTC (rev 20739) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2010-12-22 07:13:10 UTC (rev 20740) @@ -25,9 +25,7 @@ <xi:include href="chap-Component_Reference-Trees.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Menus_and_toolbars.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Output_and_messages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- <xi:include href="chap-Component_Reference-Drag_and_drop.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> <xi:include href="chap-Component_Reference-Layout_and_appearance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!-- Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Drag_and_drop.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Drag_and_drop.xml 2010-12-22 02:44:21 UTC (rev 20739) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Drag_and_drop.xml 2010-12-22 07:13:10 UTC (rev 20740) @@ -3,50 +3,154 @@ ]> <chapter id="chap-Component_Reference-Drag_and_drop"> <title>Drag and drop</title> - <para> - Incomplete - </para> - <section id="sect-Component_Reference-Drag_and_drop-richdragIndicator"> - <title><sgmltag>&lt;rich:dragIndicator&gt;</sgmltag></title> + <!-- In development notification --> + <important> + <title>Documentation in development</title> <para> - Incomplete + Some concepts covered in this chapter may refer to the previous version of <productname>Richfaces</productname>, version 3.3.3. This chapter is scheduled for review to ensure all information is up to date. </para> - </section> + </important> - <section id="sect-Component_Reference-Drag_and_drop-richdragSupport"> - <title><sgmltag>&lt;rich:dragSupport&gt;</sgmltag></title> + <para> + Read this chapter for details on adding drag and drop support to controls. + </para> + + <!-- <rich:dragBehavior> --> + <section id="sect-Component_Reference-Drag_and_drop-richdragBehavior"> + <title><sgmltag>&lt;rich:dragBehavior&gt;</sgmltag></title> <para> - Incomplete + The <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior can be added to a component to indicate it is capable of being dragged by the user. The dragged item can then be dropped into a compatible drop area, designated using the <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior. </para> + + <section id="sect-Component_Reference-richdragBehavior-Basic_usage"> + <title>Basic usage</title> + <para> + To add drag support to a component, attach the <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior as a child element. + </para> + <para> + The <varname>type</varname> attribute must be specified, and can be any identifying string. Dragged items can only be dropped in drop zones where the <varname>type</varname> attribute of the <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior is listed in the <varname>acceptedTypes</varname> attribute of the <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior. + </para> + </section> + + <section id="sect-Component_Reference-richdragBehavior-Dragging_bound_data"> + <title>Dragging bound data</title> + <para> + To bind data to the dragged object, use the <varname>dragValue</varname> attribute. The <varname>dragValue</varname> attribute specifies an item in a data model, which is then bound to the parent component when it is dragged. This facilitates handling event data during a drop event. + </para> + </section> + + <section id="sect-Component_Reference-richdragBehavior-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.DragBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDragBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.DragBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DragBehaviorRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DragBehaviorTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - - <section id="sect-Component_Reference-Drag_and_drop-richdropSupport"> - <title><sgmltag>&lt;rich:dropSupport&gt;</sgmltag></title> + + <!-- <rich:dropBehavior> --> + <section id="sect-Component_Reference-Drag_and_drop-richdropBehavior"> + <title><sgmltag>&lt;rich:dropBehavior&gt;</sgmltag></title> <para> - Incomplete + The <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior can be added to a component so that the component can accept dragged items. The dragged items must support the <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior, and be of a compatible drop type. </para> + + <section id="sect-Component_Reference-richdropBehavior-Basic_usage"> + <title>Basic usage</title> + <para> + To allow dragged items to be dropped on a component, attach the <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior as a child element to the component. + </para> + <para> + The <varname>acceptedTypes</varname> attribute must be specified. The <varname>acceptedTypes</varname> attribute is a comma-separated list of strings that match the types of dragged items. Dragged items can only be dropped in drop zones where the <varname>type</varname> attribute of the <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior is listed in the <varname>acceptedTypes</varname> attribute of the <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior. + </para> + </section> + + <section id="sect-Component_Reference-richdropBehavior-Handling_dropped_data"> + <title>Handling dropped data</title> + <para> + To provide additional parameters for a drop event, use the <varname>dropValue</varname> attribute. + </para> + <para> + The <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior raises the <varname>DropEvent</varname> server-side event when an object is dropped. The event uses the following parameters: + </para> + <itemizedlist> + <listitem> + <para> + The <parameter>dragComponent</parameter> identifies the component being dragged (the parent of the <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior). + </para> + </listitem> + <listitem> + <para> + The <parameter>dropComponent</parameter> parameter identifies the drop zone component (the parent of the <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior). + </para> + </listitem> + <listitem> + <para> + The <parameter>dragSource</parameter> parameter is the content of the <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior's <varname>dragValue</varname> attribute. + </para> + </listitem> + <listitem> + <para> + The <parameter>dropSource</parameter> parameter is the content of the <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior's <varname>dropValue</varname> attribute. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richdropBehavior-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.DropBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDropBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.DropBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DropBehaviorRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DropBehaviorTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - - <section id="sect-Component_Reference-Drag_and_drop-richdragListener"> - <title><sgmltag>&lt;rich:dragListener&gt;</sgmltag></title> - <para> - Incomplete - </para> - </section> - - <section id="sect-Component_Reference-Drag_and_drop-richdropListener"> - <title><sgmltag>&lt;rich:dropListener&gt;</sgmltag></title> - <para> - Incomplete - </para> - </section> - - <section id="sect-Component_Reference-Drag_and_drop-richdndParam"> - <title><sgmltag>&lt;rich:dndParam&gt;</sgmltag></title> - <para> - Incomplete - </para> - </section> </chapter> Modified: modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml =================================================================== --- modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-12-22 02:44:21 UTC (rev 20739) +++ modules/docs/trunk/Migration_Guide/src/main/docbook/en-US/Changes_and_new_features.xml 2010-12-22 07:13:10 UTC (rev 20740) @@ -854,9 +854,9 @@ </section> <section id="sect-Migration_Guide-Feature_changes-a4jmessage_and_a4jmessages"> - <title><sgmltag>&lt;a4j:message&gt;</sgmltag> and <sgmltag>&lt;a4j:messages&gt;</sgmltag></title> + <title><sgmltag>&lt;rich:message&gt;</sgmltag> and <sgmltag>&lt;rich:messages&gt;</sgmltag></title> <para> - Both the <sgmltag>&lt;a4j:message&gt;</sgmltag> and <sgmltag>&lt;a4j:messages&gt;</sgmltag> components can be automatically updated by any Ajax request, except those requests with <code>limitRender = true</code>. Attributes from previously-passed states are now cleared. + Both the <sgmltag>&lt;rich:message&gt;</sgmltag> and <sgmltag>&lt;rich:messages&gt;</sgmltag> components can be automatically updated by any Ajax request, except those requests with <code>limitRender = true</code>. Attributes from previously-passed states are now cleared. </para> </section> @@ -967,6 +967,13 @@ </para> </section> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richdragBehavior_and_richdropBehavior"> + <title><sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> and <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior replaces the old <sgmltag>&lt;rich:dragSupport&gt;</sgmltag> component. The <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior replaces the old <sgmltag>&lt;rich:dropSupport&gt;</sgmltag> component. + </para> + </section> + <section id="sect-Migration_Guide-Consolidated_or_renamed_components-richextendedDataTable"> <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag></title> <para> @@ -1058,6 +1065,13 @@ </para> </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richdragSupport_and_richdropSupport"> + <title><sgmltag>&lt;rich:dragSupport&gt;</sgmltag> and <sgmltag>&lt;rich:dropSupport&gt;</sgmltag></title> + <para> + The functionality of the old <sgmltag>&lt;rich:dragSupport&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:dragBehavior&gt;</sgmltag> behavior. The functionality of the old <sgmltag>&lt;rich:dropSupport&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:dropBehavior&gt;</sgmltag> behavior. + </para> + </section> + <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richmodalPanel"> <title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag></title> <para> @@ -1068,7 +1082,7 @@ <section id="sect-Migration_Guide-Deprecated_components_and_behaviors-richpanelBar_and_richpanelBarItem"> <title><sgmltag>&lt;rich:panelBar&gt;</sgmltag> and <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag></title> <para> - The functionality of the old <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. The functionality of the old <sgmltag>&lt;rich:panelBarIten&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. + The functionality of the old <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:accordion&gt;</sgmltag> component. The functionality of the old <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> component is now available through the <sgmltag>&lt;rich:accordionItem&gt;</sgmltag> component. </para> </section>