org.icefaces.ace.component.gmap

## Class GMapServicesBase

- java.lang.Object
- - javax.faces.component.UIComponent
  - - javax.faces.component.UIComponentBase
    - - javax.faces.component.UIPanel
      - - org.icefaces.ace.component.gmap.GMapServicesBase

- All Implemented Interfaces:
    java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IGMapServices
  Direct Known Subclasses:
    GMapServices

      public abstract class GMapServicesBase
      extends javax.faces.component.UIPanel
      implements IGMapServices

  The ace:gMapServices tag allows access to the various 'services' that Google provides through its maps API. Elevation gives the height of any point above or below sea level. Max zoom gives the highest level of satellite zoom available. Distance gives the distance between two points along a set mode of transit and directions show the way between given locations. For more information, see the gMap Wiki Documentation.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `GMapServicesBase.PropertyKeys`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static java.lang.String` | `COMPONENT_TYPE`
    `static java.lang.String` | `RENDERER_TYPE`

    - ### Fields inherited from class javax.faces.component.UIPanel

      `COMPONENT_FAMILY`

    - ### Fields inherited from class javax.faces.component.UIComponent

      `ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `GMapServicesBase()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getDiv()` Return the value of the `div` property.
    `java.lang.String` | `getFamily()`
    `java.lang.String` | `getName()` Return the value of the `name` property.
    `java.lang.String` | `getOptions()` Return the value of the `options` property.
    `java.lang.String` | `getPoints()` Return the value of the `points` property.
    `protected boolean` | `isPropertySet(java.lang.String finder)`
    `void` | `setDiv(java.lang.String div)` Set the value of the `div` property.
    `void` | `setName(java.lang.String name)` Set the value of the `name` property.
    `void` | `setOptions(java.lang.String options)` Set the value of the `options` property.
    `void` | `setPoints(java.lang.String points)` Set the value of the `points` property.
    `void` | `setValueExpression(java.lang.String name, javax.el.ValueExpression binding)`

    - ### Methods inherited from class javax.faces.component.UIComponentBase

      `addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent`

    - ### Methods inherited from class javax.faces.component.UIComponent

      `encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### COMPONENT_TYPE

          public static final java.lang.String COMPONENT_TYPE

      See Also:
        Constant Field Values

    - #### RENDERER_TYPE

          public static final java.lang.String RENDERER_TYPE

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### GMapServicesBase

          public GMapServicesBase()

  - ### Method Detail

    - #### getFamily

          public java.lang.String getFamily()

      Overrides:
        `getFamily` in class `javax.faces.component.UIPanel`

    - #### setDiv

          public void setDiv(java.lang.String div)

      Set the value of the `div` property.

      Contents: Id of the div you with to set text directions in. null or none to clear.

      Specified by:
        `setDiv` in interface `IGMapServices`

    - #### getDiv

          public java.lang.String getDiv()

      Return the value of the `div` property.

      Contents: Id of the div you with to set text directions in. null or none to clear. Default = 'none'.

      Specified by:
        `getDiv` in interface `IGMapServices`

    - #### setName

          public void setName(java.lang.String name)

      Set the value of the `name` property.

      Contents: The name of the service type you want to create. Valid entries are: 'Directions', 'Elevation', 'MaxZoom', 'Distance' (Case insensitive).

      Specified by:
        `setName` in interface `IGMapServices`

    - #### getName

          public java.lang.String getName()

      Return the value of the `name` property.

      Contents: The name of the service type you want to create. Valid entries are: 'Directions', 'Elevation', 'MaxZoom', 'Distance' (Case insensitive).

      Specified by:
        `getName` in interface `IGMapServices`

    - #### setOptions

          public void setOptions(java.lang.String options)

      Set the value of the `options` property.

      Contents: Additional options to be sent to the service. Check google maps API for more specifics at https://developers.google.com/maps/documentation/javascript/reference. Form is attribute:'value'.

      Specified by:
        `setOptions` in interface `IGMapServices`

    - #### getOptions

          public java.lang.String getOptions()

      Return the value of the `options` property.

      Contents: Additional options to be sent to the service. Check google maps API for more specifics at https://developers.google.com/maps/documentation/javascript/reference. Form is attribute:'value'. Default = 'travelMode:'DRIVING''.

      Specified by:
        `getOptions` in interface `IGMapServices`

    - #### setPoints

          public void setPoints(java.lang.String points)

      Set the value of the `points` property.

      Contents: The points that the service is applied to. Format is (lat,long) or, for Directions and Distance only, a standard address. Separate points with ':'.

      Specified by:
        `setPoints` in interface `IGMapServices`

    - #### getPoints

          public java.lang.String getPoints()

      Return the value of the `points` property.

      Contents: The points that the service is applied to. Format is (lat,long) or, for Directions and Distance only, a standard address. Separate points with ':'.

      Specified by:
        `getPoints` in interface `IGMapServices`

    - #### isPropertySet

          protected boolean isPropertySet(java.lang.String finder)

    - #### setValueExpression

          public void setValueExpression(java.lang.String name,
                                         javax.el.ValueExpression binding)

      Overrides:
        `setValueExpression` in class `javax.faces.component.UIComponent`

Copyright 2025 ICEsoft Technologies Canada, Corp. All Rights Reserved.