org.icefaces.ace.component.gmap

## Class GMapMarkerBase

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

- 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, IGMapMarker
  Direct Known Subclasses:
    GMapMarker

      public abstract class GMapMarkerBase
      extends javax.faces.component.UIPanel
      implements IGMapMarker

  The ace:gMapMarker component places one of Google's markers upon the given latitude/longitude coordinates of the parent ace:gMap. For more information, see the gMap Wiki Documentation.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `GMapMarkerBase.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
    `GMapMarkerBase()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getAddress()` Return the value of the `address` property.
    `java.lang.String` | `getAnimation()` Return the value of the `animation` property.
    `javax.el.MethodExpression` | `getDragDropListener()` Return the value of the `dragDropListener` property.
    `java.lang.String` | `getFamily()`
    `java.lang.String` | `getLatitude()` Return the value of the `latitude` property.
    `java.lang.String` | `getLongitude()` Return the value of the `longitude` property.
    `java.lang.String` | `getOptions()` Return the value of the `options` property.
    `java.lang.Boolean` | `isDisabled()` Return the value of the `disabled` property.
    `protected boolean` | `isPropertySet(java.lang.String finder)`
    `void` | `setAddress(java.lang.String address)` Set the value of the `address` property.
    `void` | `setAnimation(java.lang.String animation)` Set the value of the `animation` property.
    `void` | `setDisabled(java.lang.Boolean disabled)` Set the value of the `disabled` property.
    `void` | `setDragDropListener(javax.el.MethodExpression dragDropListener)` Set the value of the `dragDropListener` property.
    `void` | `setLatitude(java.lang.String latitude)` Set the value of the `latitude` property.
    `void` | `setLongitude(java.lang.String longitude)` Set the value of the `longitude` property.
    `void` | `setOptions(java.lang.String options)` Set the value of the `options` 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

    - #### GMapMarkerBase

          public GMapMarkerBase()

  - ### Method Detail

    - #### getFamily

          public java.lang.String getFamily()

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

    - #### setAddress

          public void setAddress(java.lang.String address)

      Set the value of the `address` property.

      Contents: The address to locate via the Google Maps Geocoder API, at which the marker will be placed after a successful geocoding request. This attribute takes precedence over latitude and longitude.

      Specified by:
        `setAddress` in interface `IGMapMarker`

    - #### getAddress

          public java.lang.String getAddress()

      Return the value of the `address` property.

      Contents: The address to locate via the Google Maps Geocoder API, at which the marker will be placed after a successful geocoding request. This attribute takes precedence over latitude and longitude.

      Specified by:
        `getAddress` in interface `IGMapMarker`

    - #### setAnimation

          public void setAnimation(java.lang.String animation)

      Set the value of the `animation` property.

      Contents: The animation that the marker should use. Valid values are 'bounce', 'drop', or 'none'.

      Specified by:
        `setAnimation` in interface `IGMapMarker`

    - #### getAnimation

          public java.lang.String getAnimation()

      Return the value of the `animation` property.

      Contents: The animation that the marker should use. Valid values are 'bounce', 'drop', or 'none'.

      Specified by:
        `getAnimation` in interface `IGMapMarker`

    - #### setDisabled

          public void setDisabled(java.lang.Boolean disabled)

      Set the value of the `disabled` property.

      Contents: Set to true to remove the marker from the map

      Specified by:
        `setDisabled` in interface `IGMapMarker`

    - #### isDisabled

          public java.lang.Boolean isDisabled()

      Return the value of the `disabled` property.

      Contents: Set to true to remove the marker from the map Default = 'false'.

      Specified by:
        `isDisabled` in interface `IGMapMarker`

    - #### setDragDropListener

          public void setDragDropListener(javax.el.MethodExpression dragDropListener)

      Set the value of the `dragDropListener` property.

      Contents: A server side listener to be invoked when the marker is dragged and dropped at a different position. The MarkerDragDropEvent object contains the new and old latitude and longitude values. Also, this component's latitude and longitude values are automatically updated as well.

      Specified by:
        `setDragDropListener` in interface `IGMapMarker`

    - #### getDragDropListener

          public javax.el.MethodExpression getDragDropListener()

      Return the value of the `dragDropListener` property.

      Contents: A server side listener to be invoked when the marker is dragged and dropped at a different position. The MarkerDragDropEvent object contains the new and old latitude and longitude values. Also, this component's latitude and longitude values are automatically updated as well.

      Specified by:
        `getDragDropListener` in interface `IGMapMarker`

    - #### setLatitude

          public void setLatitude(java.lang.String latitude)

      Set the value of the `latitude` property.

      Contents: The latitude for the marker.

      Specified by:
        `setLatitude` in interface `IGMapMarker`

    - #### getLatitude

          public java.lang.String getLatitude()

      Return the value of the `latitude` property.

      Contents: The latitude for the marker.

      Specified by:
        `getLatitude` in interface `IGMapMarker`

    - #### setLongitude

          public void setLongitude(java.lang.String longitude)

      Set the value of the `longitude` property.

      Contents: The longitude for the marker.

      Specified by:
        `setLongitude` in interface `IGMapMarker`

    - #### getLongitude

          public java.lang.String getLongitude()

      Return the value of the `longitude` property.

      Contents: The longitude for the marker.

      Specified by:
        `getLongitude` in interface `IGMapMarker`

    - #### setOptions

          public void setOptions(java.lang.String options)

      Set the value of the `options` property.

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

      Specified by:
        `setOptions` in interface `IGMapMarker`

    - #### getOptions

          public java.lang.String getOptions()

      Return the value of the `options` property.

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

      Specified by:
        `getOptions` in interface `IGMapMarker`

    - #### 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.