org.icefaces.ace.component.gmap

## Class GMapLayerBase

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

- 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, IGMapLayer
  Direct Known Subclasses:
    GMapLayer

      public abstract class GMapLayerBase
      extends javax.faces.component.UIPanel
      implements IGMapLayer

  The ace:gMapLayer component creates one of a variety of layers on top of the parent ace:gMap, to enhance or display new information. Google provides Bicycling, Traffic and Transit layers, which display bike paths, traffic flow and public transportations routes respectively. Alternatively, a user defined kml file can also be used. For more information, see the gMap Wiki Documentation.

- - ### Nested Class Summary

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

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getFamily()`
    `java.lang.String` | `getLayerType()` Return the value of the `layerType` property.
    `java.lang.String` | `getOptions()` Return the value of the `options` property.
    `java.lang.String` | `getUrl()` Return the value of the `url` property.
    `protected boolean` | `isPropertySet(java.lang.String finder)`
    `boolean` | `isVisible()` Return the value of the `visible` property.
    `void` | `setLayerType(java.lang.String layerType)` Set the value of the `layerType` property.
    `void` | `setOptions(java.lang.String options)` Set the value of the `options` property.
    `void` | `setUrl(java.lang.String url)` Set the value of the `url` property.
    `void` | `setValueExpression(java.lang.String name, javax.el.ValueExpression binding)`
    `void` | `setVisible(boolean visible)` Set the value of the `visible` property.

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

    - #### GMapLayerBase

          public GMapLayerBase()

  - ### Method Detail

    - #### getFamily

          public java.lang.String getFamily()

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

    - #### setLayerType

          public void setLayerType(java.lang.String layerType)

      Set the value of the `layerType` property.

      Contents: The type of layer that you wish to create. Options are 'Bicycling', 'Traffic', 'Transit', 'Fusion' and 'Kml'. (Case insensitive)

      Specified by:
        `setLayerType` in interface `IGMapLayer`

    - #### getLayerType

          public java.lang.String getLayerType()

      Return the value of the `layerType` property.

      Contents: The type of layer that you wish to create. Options are 'Bicycling', 'Traffic', 'Transit', 'Fusion' and 'Kml'. (Case insensitive)

      Specified by:
        `getLayerType` in interface `IGMapLayer`

    - #### setOptions

          public void setOptions(java.lang.String options)

      Set the value of the `options` property.

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

      Specified by:
        `setOptions` in interface `IGMapLayer`

    - #### getOptions

          public java.lang.String getOptions()

      Return the value of the `options` property.

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

      Specified by:
        `getOptions` in interface `IGMapLayer`

    - #### setUrl

          public void setUrl(java.lang.String url)

      Set the value of the `url` property.

      Contents: The URL from which to draw kml data.

      Specified by:
        `setUrl` in interface `IGMapLayer`

    - #### getUrl

          public java.lang.String getUrl()

      Return the value of the `url` property.

      Contents: The URL from which to draw kml data.

      Specified by:
        `getUrl` in interface `IGMapLayer`

    - #### setVisible

          public void setVisible(boolean visible)

      Set the value of the `visible` property.

      Contents: Whether to make the chosen layer visible or not.

      Specified by:
        `setVisible` in interface `IGMapLayer`

    - #### isVisible

          public boolean isVisible()

      Return the value of the `visible` property.

      Contents: Whether to make the chosen layer visible or not.

      Specified by:
        `isVisible` in interface `IGMapLayer`

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