Author: vkorluzhenko Date: 2007-07-24 08:53:44 -0400 (Tue, 24 Jul 2007) New Revision: 1821 Added: trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.desc.xml trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.xml Log: http://jira.jboss.com/jira/browse/RF-458 Added: trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.desc.xml (rev 0) +++ trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.desc.xml 2007-07-24 12:53:44 UTC (rev 1821) @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> +<sectioninfo> +<keywordset> + <keyword>virtualEarth</keyword> +</keywordset> +</sectioninfo> +<section> +<title>Description</title> + <para>Component that presents the Microsoft <property>Virtual Earth map</property> in the JSF applications.</para> + <figure> + <title>virtualEarth component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/virtualEarth.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Key Features</title> + <itemizedlist> + <listitem>Presents the Microsoft <property>Virtual Earth map</property> functional</listitem> + <listitem>Highly customizable via attributes</listitem> + <listitem>No developers JavaScript writing needed to use on the pages</listitem> + </itemizedlist> +</section> +</section> Added: trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.xml (rev 0) +++ trunk/docs/userguide/en/src/main/docbook/included/virtualEarth.xml 2007-07-24 12:53:44 UTC (rev 1821) @@ -0,0 +1,135 @@ +<?xml version='1.0' encoding='UTF-8'?> +<section> + <sectioninfo> + <keywordset> + <keyword>map</keyword> + <keyword>Virtual Earth</keyword> + </keywordset> + </sectioninfo> + + <table> + <title>Component identification parameters </title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>component-type</entry> + <entry>org.richfaces.VirtualEarth</entry> + </row> + <row> + <entry>component-class</entry> + <entry>org.richfaces.component.html.HtmlVirtualEarth</entry> + </row> + <row> + <entry>component-family</entry> + <entry>org.richfaces.VirtualEarth</entry> + </row> + <row> + <entry>renderer-type</entry> + <entry>org.richfaces.VirtualEarthRenderer</entry> + </row> + <row> + <entry>tag-class</entry> + <entry>org.richfaces.taglib.VirtualEarthTag</entry> + </row> + </tbody> + </tgroup> + </table> + + <section> + <title>Creating the Component with a Page Tag</title> + <para>Here is a simple example as it might be used in a page: </para> + + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="XML"><![CDATA[... + <rich:virtualEarth var="map"/> +... +]]></programlisting> + </section> + <section> + <title>Creating the Component Dynamically Using Java</title> + + <para> + <emphasis role="bold">Example:</emphasis> + </para> + <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlVirtualEarth; +... +HtmlVirtualEarth myMap = new HtmlVirtualEarth(); +... +]]></programlisting> + </section> + <section> + <title>Details of Usage</title> + + <para>Here are the main settings of initial rendering performed with a component + <property>map</property> that are accessible with the following attributes:</para> + <itemizedlist> + <listitem> + <emphasis> + <property>&quot;zoom&quot;</property> + </emphasis> defines an approximation size (boundary values 1-18) </listitem> + <listitem> + <emphasis> + <property>&quot;lat&quot;</property> + </emphasis> specifies an initial latitude coordinate in degrees, as a number between -90 and + +90 </listitem> + <listitem> + <emphasis> + <property>&quot;lng&quot;</property> + </emphasis> specifies an initial longitude coordinate in degrees, as a number between -180 + and +180 </listitem> + <listitem> + <emphasis> + <property>&quot;dashboardSize&quot;</property> + </emphasis>specifies a type of a rendered map (Normal, Small, Tiny)</listitem> + </itemizedlist> + <para>For example, the city of Paris is shown after rendering with the following initial + settings: <emphasis> + <property>&quot;lat&quot;</property> + </emphasis>= 48.833, <emphasis> + <property>&quot;lng&quot;</property> + </emphasis>= 2.40 and <emphasis> + <property>&quot;zoom&quot;</property> + </emphasis>= 11.</para> + <figure> + <title>virtualEarth initial rendering</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/virtualEarth1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Code for this example is placed below:</para> + <programlisting role="XML"><![CDATA[... + <rich:virtualEarth style="width:800px;" id="vm" lat="48.833" lng="2.40" + dashboardSize="Normal" zoom="11" mapStyle="Hybrid" var="map" /> +... +]]></programlisting> + + </section> + <!--section> + <title>Look-and-Feel Customization</title> + <para><property>Virtual Earth map</property> component isn&apos;t tied to skin parameters, as there is no + additional elements on it, except the ones provided with <emphasis><property>Virtual Earth map</property>.</emphasis></para> + </section> + <section> + <title>Definition custom style classes:</title> + <para>rich-virtualEarth map is a predefined style class for the map. It&apos;s possible to define some + standard properties for all <property>maps</property> components on a page (padding, border, + etc.) with the definition of the component.</para> + </section--> + <section> + <title>Relevant resources links</title> + <para> + <ulink url="http://msdn2.microsoft.com/en-us/library/bb429619.aspx">... you can found + information about Microsoft <property>Virtual Earth map</property>.</para> + </section> + +</section>