org.icefaces.ace.component.gmap

Class GMapEventBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.icefaces.ace.component.gmap.GMapEventBase

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, IGMapEvent

Direct Known Subclasses:

GMapEvent

public abstract class GMapEventBase
extends javax.faces.component.UIPanel
implements IGMapEvent

The ace:gMapEvent component allows the other Google maps subcomponents to integrate with the google event handling API and execute user defined code. For more information, see the gMap Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GMapEventBase.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
GMapEventBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getEventType() Return the value of the eventType property.
java.lang.String	getFamily()
javax.el.MethodExpression	getListener() Return the value of the listener property.
java.lang.String	getScriptToUse() Return the value of the scriptToUse property.
java.lang.Boolean	isDisabled() Return the value of the disabled property.
protected boolean	isPropertySet(java.lang.String finder)
void	setDisabled(java.lang.Boolean disabled) Set the value of the disabled property.
void	setEventType(java.lang.String eventType) Set the value of the eventType property.
void	setListener(javax.el.MethodExpression listener) Set the value of the listener property.
void	setScriptToUse(java.lang.String scriptToUse) Set the value of the scriptToUse 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, getPassThroughAttributes, 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, getPassThroughAttributes, 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

GMapEventBase

public GMapEventBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

setDisabled

public void setDisabled(java.lang.Boolean disabled)

Set the value of the disabled property.

Contents: Set to true to remove the event from the map.

Specified by:

setDisabled in interface IGMapEvent

isDisabled

public java.lang.Boolean isDisabled()

Return the value of the disabled property.

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

Specified by:

isDisabled in interface IGMapEvent

setEventType

public void setEventType(java.lang.String eventType)

Set the value of the eventType property.

Contents: The type of event that you want the script to execute on. The script will execute when the parent component of this tag fires the chosen event. Valid types vary based on parent tag, but can be found under the parent's mention in the google API.

Specified by:

setEventType in interface IGMapEvent

getEventType

public java.lang.String getEventType()

Return the value of the eventType property.

Contents: The type of event that you want the script to execute on. The script will execute when the parent component of this tag fires the chosen event. Valid types vary based on parent tag, but can be found under the parent's mention in the google API.

Specified by:

getEventType in interface IGMapEvent

setListener

public void setListener(javax.el.MethodExpression listener)

Set the value of the listener property.

Contents: Method expression referencing a method that will be called when a MapEvent has been broadcast for the listener. The server request will be sent after the client-side script is executed, if any.

Specified by:

setListener in interface IGMapEvent

getListener

public javax.el.MethodExpression getListener()

Return the value of the listener property.

Contents: Method expression referencing a method that will be called when a MapEvent has been broadcast for the listener. The server request will be sent after the client-side script is executed, if any.

Specified by:

getListener in interface IGMapEvent

setScriptToUse

public void setScriptToUse(java.lang.String scriptToUse)

Set the value of the scriptToUse property.

Contents: The script to be executed when the chosen event is fired. Use the variable 'map' to refer to the parent gMap (a google.maps.Map instance) and 'component' to refer to the Google Maps API Javascript object corresponding to the parent tag.

Specified by:

setScriptToUse in interface IGMapEvent

getScriptToUse

public java.lang.String getScriptToUse()

Return the value of the scriptToUse property.

Contents: The script to be executed when the chosen event is fired. Use the variable 'map' to refer to the parent gMap (a google.maps.Map instance) and 'component' to refer to the Google Maps API Javascript object corresponding to the parent tag.

Specified by:

getScriptToUse in interface IGMapEvent

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