<?xml version='1.0' encoding='UTF-8'?>
<section>
  <sectioninfo>
    <keywordset>
      <keyword>map</keyword>
      <keyword>gmapVar</keyword>
      <keyword>HtmlGmap</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.Gmap</entry>
        </row>
        <row>
          <entry>component-class</entry>
          <entry>org.richfaces.component.html.HtmlGmap</entry>
        </row>
        <row>
          <entry>component-family</entry>
          <entry>org.richfaces.Gmap</entry>
        </row>
        <row>
          <entry>renderer-type</entry>
          <entry>org.richfaces.GmapRenderer</entry>
        </row>
        <row>
          <entry>tag-class</entry>
          <entry>org.richfaces.taglib.GmapTag</entry>
        </row>
      </tbody>
    </tgroup>
  </table>

  <section>
    <title>Creating the Component with a Page Tag</title>
    <para>Here is a simple example as it could be used on a page: </para>

    <para>
      <emphasis role="bold">Example:</emphasis>
    </para>
    <programlisting role="XML"><![CDATA[...
    <rich:gmap gmapKey="..."/>
...
]]></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.HtmlGmap;
...
HtmlGmap myMap = new HtmlGmap();
...
]]></programlisting>
  </section>
  <section>
    <title>Details of Usage</title>
    <para>To use <emphasis>
        <property>Google Map</property>
      </emphasis> in your application, generate a key on <ulink url="http://google.com/apis/maps"
        >Google Map official resource</ulink>. One key could be used for one directory on the
      server.</para>
    <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;mapType&quot;</property>
        </emphasis> specifies a type of a rendered map (G_NORMAL_MAP, G_SATELLITE_MAP (DEFAULT),
        G_HYBRID_MAP) </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.44, <emphasis>
        <property>&quot;lng&quot;</property>
      </emphasis>= 2.24 and <emphasis>
        <property>&quot;zoom&quot;</property>
      </emphasis>= 5.</para>
    <figure>
      <title>&lt;rich:gmap&gt; initial rendering</title>
      <mediaobject>
        <imageobject>
          <imagedata fileref="images/gmap1.png"/>
        </imageobject>
      </mediaobject>
    </figure>
    <para> It&apos;s also possible to set accessible controls on the <property>map</property>
      with the help of the attributes:</para>
    <itemizedlist>
      <listitem>
        <emphasis>
          <property>&quot;showGMapTypeControl&quot;</property>
        </emphasis> determines whether the controls for a map type definition are switched on </listitem>
      <listitem>
        <emphasis>
          <property>&quot;showGScaleControl&quot;</property>
        </emphasis> determines whether the controls for scaling are switched on </listitem>
      <listitem>
        <emphasis>
          <property>&quot;showGLargeMapControl&quot;</property>
        </emphasis> determines whether the control for <property>map</property> scale rendering is
        rendered </listitem>
    </itemizedlist>
    <figure>
      <title>&lt;rich:gmap&gt; accessible controls</title>
      <mediaobject>
        <imageobject>
          <imagedata fileref="images/gmap3.png"/>
        </imageobject>
      </mediaobject>
    </figure>
    <para>To set all these parameters and perform some activity (Zoom In/Out etc.) is possible with
      your JavaScript, i.e. declare a name of an object on a <property>map</property> in the <emphasis>
        <property>&quot;gmapVar&quot;</property>
      </emphasis> attribute and then call the object directly with API <emphasis><property>Google
          Map</property>.</emphasis></para>
    <para>For example, to approximate a map for <emphasis>
        <property>&quot;gmapVar&quot;</property>
      </emphasis>= <property>&quot;map&quot;</property> declared inside the component, call
      map.zoomIn() on an event.</para>
    <para>Moreover, to add e.g. some JavaScript effects, events defined on it are used.</para>
    <itemizedlist>
      <listitem> onmouseover </listitem>
      <listitem> onclick </listitem>
      <listitem> onmouseout </listitem>
      <listitem> etc. </listitem>
    </itemizedlist>
    
    <note>
      <para>
        Google Map does not support XHTML format of the page. 
        Thus, if you use Facelets and JSF 1.2, do not forget to put the following tags somewhere on the page:
      </para>
        <programlisting role="XML"><![CDATA[...
<f:view contentType="text/html">...</f:view>
...
]]></programlisting>
    </note>
    
  </section>
  <section>
    <title>Look-and-Feel Customization</title>
    <para><emphasis role="bold">
        <property>&lt;rich:gmap&gt;</property>
      </emphasis> component isn&apos;t tied to skin parameters, as there is no additional
      elements on it, except the ones provided with <emphasis><property>Google
      Map</property>.</emphasis></para>
    </section>
  
  <section>
    <title>Definition of Custom Style Classes</title>
    <table>
      <title>Classes names that define a component appearance</title>
      <tgroup cols="2">
        <thead>
          <row>
            <entry>Class name</entry>
            <entry>Description</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>rich-gmap</entry>
            <entry>Defines styles for a wrapper &lt;div&gt; element of a component</entry>
          </row>
        </tbody>
      </tgroup>
    </table>

    <para>In order to redefine styles for all <emphasis role="bold">
        <property>&lt;rich:gmap&gt;</property>
      </emphasis> components on a page using CSS, it&apos;s enough to create class with the same
      name and define necessary properties in it.</para>

    <para>To change styles of particular <emphasis role="bold">
        <property>&lt;rich:gmap&gt;</property>
      </emphasis> components, define your own style class in the corresponding <emphasis role="bold">
        <property>&lt;rich:gmap&gt;</property>
      </emphasis>attribute.</para>
  </section>
  <section>
    <title>Relevant Resources Links</title>
    <para>
      <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/gmap.jsf?c=gmap">Here</ulink>
      you can see the example of <emphasis role="bold">
        <property>&lt;rich:gmap&gt;</property>
      </emphasis> usage and sources for the given example. </para>
  </section>

</section>
