org.icefaces.ace.component.gmap
Class GMapControlBase

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

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

Direct Known Subclasses:

GMapControl

public class GMapControlBase
extends javax.faces.component.UIPanel
implements IGMapControl

The ace:gMapControl component serves as an easy interface to modify the position, style and rendered state of the controls that appear on the ace:gMap that this tag is nested within. For more information, see the gMap Wiki Documentation.

Nested Class Summary

protected static class

GMapControlBase.PropertyKeys

Field Summary

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

GMapControlBase()

Method Summary

java.lang.String	getControlStyle() Return the value of the controlStyle property.
java.lang.String	getFamily()
java.lang.String	getName() Return the value of the name property.
java.lang.String	getPosition() Return the value of the position property.
boolean	isDisabled() Return the value of the disabled property.
void	setControlStyle(java.lang.String controlStyle) Set the value of the controlStyle property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setName(java.lang.String name) Set the value of the name property.
void	setPosition(java.lang.String position) Set the value of the position 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, setValueExpression, 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

GMapControlBase

public GMapControlBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

setControlStyle

public void setControlStyle(java.lang.String controlStyle)

Set the value of the controlStyle property.

Contents: The style that will be used on the control. Will only affect Zoom and Type controls. Type style options are: 'default', 'dropdown' and 'bar'. Zoom style options are 'default', 'large' and 'small'.

Specified by:

setControlStyle in interface IGMapControl

getControlStyle

public java.lang.String getControlStyle()

Return the value of the controlStyle property.

Contents: The style that will be used on the control. Will only affect Zoom and Type controls. Type style options are: 'default', 'dropdown' and 'bar'. Zoom style options are 'default', 'large' and 'small'. Default = 'none'.

Specified by:

getControlStyle in interface IGMapControl

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: Choose whether or not to display the chosen map control.

Specified by:

setDisabled in interface IGMapControl

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: Choose whether or not to display the chosen map control. Default = 'false'.

Specified by:

isDisabled in interface IGMapControl

setName

public void setName(java.lang.String name)

Set the value of the name property.

Contents: The name of the control to affect. Valid entries are: 'all', 'type', 'overview', 'pan', 'rotate', 'scale', 'streetView' and 'zoom'.

Specified by:

setName in interface IGMapControl

getName

public java.lang.String getName()

Return the value of the name property.

Contents: The name of the control to affect. Valid entries are: 'all', 'type', 'overview', 'pan', 'rotate', 'scale', 'streetView' and 'zoom'.

Specified by:

getName in interface IGMapControl

setPosition

public void setPosition(java.lang.String position)

Set the value of the position property.

Contents: The location for the chosen control to display. Valid entries are 'bottomCenter', 'bottomLeft', 'bottomRight', 'leftBottom', 'leftCenter', 'leftTop', 'rightBottom', 'rightCenter', 'rightTop', 'topCenter', 'topLeft' and 'topRight'.

Specified by:

setPosition in interface IGMapControl

getPosition

public java.lang.String getPosition()

Return the value of the position property.

Contents: The location for the chosen control to display. Valid entries are 'bottomCenter', 'bottomLeft', 'bottomRight', 'leftBottom', 'leftCenter', 'leftTop', 'rightBottom', 'rightCenter', 'rightTop', 'topCenter', 'topLeft' and 'topRight'. Default = 'none'.

Specified by:

getPosition in interface IGMapControl