org.icefaces.ace.component.gmap

## Class GMapInfoWindowBase

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

- 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, IGMapInfoWindow
  Direct Known Subclasses:
    GMapInfoWindow

      public abstract class GMapInfoWindowBase
      extends javax.faces.component.UIPanel
      implements IGMapInfoWindow

  The ace:gMapInfoWindow component creates a pop-up window within the parent ace:gMap, which can be used to display either text via the 'content' attribute or nested html or jsf tags. If placed within an ace:gMapMarker, the window will 'bind' to the marker, and move along with it. For more information, see the gMap Wiki Documentation.

- - ### Nested Class Summary

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

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getContent()` Return the value of the `content` 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)`
    `boolean` | `isShowOnClick()` Return the value of the `showOnClick` property.
    `boolean` | `isStartOpen()` Return the value of the `startOpen` property.
    `void` | `setContent(java.lang.String content)` Set the value of the `content` property.
    `void` | `setDisabled(java.lang.Boolean disabled)` Set the value of the `disabled` 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` | `setShowOnClick(boolean showOnClick)` Set the value of the `showOnClick` property.
    `void` | `setStartOpen(boolean startOpen)` Set the value of the `startOpen` 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

    - #### GMapInfoWindowBase

          public GMapInfoWindowBase()

  - ### Method Detail

    - #### getFamily

          public java.lang.String getFamily()

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

    - #### setContent

          public void setContent(java.lang.String content)

      Set the value of the `content` property.

      Contents: The text content to be displayed within the info window. If this component has child tags(either html or another jsf component), this attribute will not be used, placing the children within the window instead.

      Specified by:
        `setContent` in interface `IGMapInfoWindow`

    - #### getContent

          public java.lang.String getContent()

      Return the value of the `content` property.

      Contents: The text content to be displayed within the info window. If this component has child tags(either html or another jsf component), this attribute will not be used, placing the children within the window instead.

      Specified by:
        `getContent` in interface `IGMapInfoWindow`

    - #### setDisabled

          public void setDisabled(java.lang.Boolean disabled)

      Set the value of the `disabled` property.

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

      Specified by:
        `setDisabled` in interface `IGMapInfoWindow`

    - #### isDisabled

          public java.lang.Boolean isDisabled()

      Return the value of the `disabled` property.

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

      Specified by:
        `isDisabled` in interface `IGMapInfoWindow`

    - #### setLatitude

          public void setLatitude(java.lang.String latitude)

      Set the value of the `latitude` property.

      Contents: The latitude for the window, will be overridden if the component is the child of a marker.

      Specified by:
        `setLatitude` in interface `IGMapInfoWindow`

    - #### getLatitude

          public java.lang.String getLatitude()

      Return the value of the `latitude` property.

      Contents: The latitude for the window, will be overridden if the component is the child of a marker.

      Specified by:
        `getLatitude` in interface `IGMapInfoWindow`

    - #### setLongitude

          public void setLongitude(java.lang.String longitude)

      Set the value of the `longitude` property.

      Contents: The longitude for the window, will be overridden if the component is the child of a marker.

      Specified by:
        `setLongitude` in interface `IGMapInfoWindow`

    - #### getLongitude

          public java.lang.String getLongitude()

      Return the value of the `longitude` property.

      Contents: The longitude for the window, will be overridden if the component is the child of a marker.

      Specified by:
        `getLongitude` in interface `IGMapInfoWindow`

    - #### setOptions

          public void setOptions(java.lang.String options)

      Set the value of the `options` property.

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

      Specified by:
        `setOptions` in interface `IGMapInfoWindow`

    - #### getOptions

          public java.lang.String getOptions()

      Return the value of the `options` property.

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

      Specified by:
        `getOptions` in interface `IGMapInfoWindow`

    - #### setShowOnClick

          public void setShowOnClick(boolean showOnClick)

      Set the value of the `showOnClick` property.

      Contents: Boolean value that determines whether or not the info window appears upon a click of the marker it is bound to. This attribute will not have any effect if the info window is not nested in a marker.

      Specified by:
        `setShowOnClick` in interface `IGMapInfoWindow`

    - #### isShowOnClick

          public boolean isShowOnClick()

      Return the value of the `showOnClick` property.

      Contents: Boolean value that determines whether or not the info window appears upon a click of the marker it is bound to. This attribute will not have any effect if the info window is not nested in a marker. Default = 'true'.

      Specified by:
        `isShowOnClick` in interface `IGMapInfoWindow`

    - #### setStartOpen

          public void setStartOpen(boolean startOpen)

      Set the value of the `startOpen` property.

      Contents: Boolean value that determines whether or not the info window will open upon loading the map, or whether it will remain hidden until the parent marker is clicked. Will only have an effect if window is nested inside a marker, and showOnClick is true.

      Specified by:
        `setStartOpen` in interface `IGMapInfoWindow`

    - #### isStartOpen

          public boolean isStartOpen()

      Return the value of the `startOpen` property.

      Contents: Boolean value that determines whether or not the info window will open upon loading the map, or whether it will remain hidden until the parent marker is clicked. Will only have an effect if window is nested inside a marker, and showOnClick is true. Default = 'true'.

      Specified by:
        `isStartOpen` in interface `IGMapInfoWindow`

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