oracle.adf.view.faces.bi.component.geoMap
Class UIGeoMapToolbar

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              oracle.adf.view.faces.bi.component.geoMap.UIGeoMapToolbar

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIGeoMapToolbar
extends org.apache.myfaces.trinidad.component.UIXComponentBase

ADF Faces Custom component - MapToolbar This component contains tools for turning on/off themes, selecting theme elements, zooming, calculating distance and area for the selected regions, displaying legend, and showing the spatial coordinates of the mouse location.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	CLICK_BUTTON
static org.apache.myfaces.trinidad.bean.PropertyKey	MAPID_KEY
static java.lang.String	MAPTOOLBARBUTTONTYPE_AREA
static java.lang.String	MAPTOOLBARBUTTONTYPE_CIRCLESELECTION
static java.lang.String	MAPTOOLBARBUTTONTYPE_HAND
static java.lang.String	MAPTOOLBARBUTTONTYPE_POINTSELECTION
static java.lang.String	MAPTOOLBARBUTTONTYPE_POLYGONSELECTION
static java.lang.String	MAPTOOLBARBUTTONTYPE_RECTSELECTION
static java.lang.String	MAPTOOLBARBUTTONTYPE_RULER
static java.lang.String	MAPTOOLBARBUTTONTYPE_ZOOMIN
static java.lang.String	MAPTOOLBARBUTTONTYPE_ZOOMOUT
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWDISTANCETOOLS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWSELECTIONTOOLS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWSELECTTHEMEDIALOG_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWSELECTTHEMEMENUITEM_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWVIEWMENU_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOWZOOMTOOLS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLECLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

UIGeoMapToolbar()

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getClickButton() For internal use only.
java.lang.String	getFamily()
java.lang.String	getMapId() Return the mapId of the map component for this toolbar
java.lang.String[]	getPartialTriggers() Return the ids of the components that should trigger a partial update.
java.lang.String	getRendererType()
java.lang.String	getStyleClass() Return the CSS style class for this component
boolean	isButtonSelected(java.lang.String buttonType)
boolean	isShowDistanceTools() Indicates whether the distance and area tools are visible or not.
boolean	isShowSelectionTools() Indicates whether selection tools -- rectangle tool, circle tool, polygon tool, and point tool -- is visible on the toolbar or not
boolean	isShowSelectThemeDialog() Indicates whether the select theme dialog is visible on the view menu of the toolbar
boolean	isShowSelectThemeMenuItem() Indicates whether "select theme" menu item is visible
boolean	isShowViewMenu() Indicates whether viewMenu is visible on the toolbar or not
boolean	isShowZoomTools() Indicates whether the zoom in and zoom out tools are visible or not.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object stateObj)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setClickButton(java.lang.String buttonType) For internal use only.
void	setMapId(java.lang.String mapId) Specifies the id of the map component that associated with this toolbar.
void	setPartialTriggers(java.lang.String[] ids) Specifies the ids of the components that should trigger a partial update.
void	setShowDistanceTools(boolean bShown) Specifies wheter distance tool and area tool will be shown on the toolbar
void	setShowSelectionTools(boolean bShown) Specifies whether selection tools -- rectangle tool, circle tool, polygon tool, and point tool -- will be shown on the toolbar.
void	setShowSelectThemeDialog(boolean bShown) Specifies whether the select theme dialog will be visible on the view menu of the toolbar
void	setShowSelectThemeMenuItem(boolean bShown) Specifies whether "select theme" menu item will be visible on the view menu of the toolbar
void	setShowViewMenu(boolean bShown) Specifies whether view menu will be shown on the toolbar
void	setShowZoomTools(boolean bShown) Specifies whether zoom in tool and zoom out tool will be shown on the toolbar.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderer, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAPTOOLBARBUTTONTYPE_RECTSELECTION

public static final java.lang.String MAPTOOLBARBUTTONTYPE_RECTSELECTION

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_CIRCLESELECTION

public static final java.lang.String MAPTOOLBARBUTTONTYPE_CIRCLESELECTION

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_POLYGONSELECTION

public static final java.lang.String MAPTOOLBARBUTTONTYPE_POLYGONSELECTION

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_POINTSELECTION

public static final java.lang.String MAPTOOLBARBUTTONTYPE_POINTSELECTION

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_ZOOMIN

public static final java.lang.String MAPTOOLBARBUTTONTYPE_ZOOMIN

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_ZOOMOUT

public static final java.lang.String MAPTOOLBARBUTTONTYPE_ZOOMOUT

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_HAND

public static final java.lang.String MAPTOOLBARBUTTONTYPE_HAND

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_RULER

public static final java.lang.String MAPTOOLBARBUTTONTYPE_RULER

See Also:

Constant Field Values

MAPTOOLBARBUTTONTYPE_AREA

public static final java.lang.String MAPTOOLBARBUTTONTYPE_AREA

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

MAPID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAPID_KEY

SHOWVIEWMENU_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOWVIEWMENU_KEY

SHOWSELECTIONTOOLS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOWSELECTIONTOOLS_KEY

SHOWZOOMTOOLS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOWZOOMTOOLS_KEY

SHOWDISTANCETOOLS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOWDISTANCETOOLS_KEY

SHOWSELECTTHEMEDIALOG_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOWSELECTTHEMEDIALOG_KEY

SHOWSELECTTHEMEMENUITEM_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOWSELECTTHEMEMENUITEM_KEY

CLICK_BUTTON

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLICK_BUTTON

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

STYLECLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLECLASS_KEY

Constructor Detail

UIGeoMapToolbar

public UIGeoMapToolbar()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getRendererType

public java.lang.String getRendererType()

Overrides:

getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase

setMapId

public void setMapId(java.lang.String mapId)

Specifies the id of the map component that associated with this toolbar. If the map does not exist, the toolbar will not work, and an exception will be thrown.

Parameters:

mapId - The id of the map component that associated with this toolbar

getMapId

public java.lang.String getMapId()

Return the mapId of the map component for this toolbar

Returns:

The mapId of the map component for this toolbar

setClickButton

public void setClickButton(java.lang.String buttonType)

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

getClickButton

public java.lang.String getClickButton()

For internal use only. Application developers should not use this.

For internal use only. Application developers should not use this

setShowViewMenu

public void setShowViewMenu(boolean bShown)

Specifies whether view menu will be shown on the toolbar

Parameters:

bShown - True if the viewMenu will be shown. False if the viewMenu will be hidden.

isShowViewMenu

public boolean isShowViewMenu()

Indicates whether viewMenu is visible on the toolbar or not

Returns:

True if the viewMenu is visible on the toolbar. False if the viewMenu is hidden.

setShowSelectionTools

public void setShowSelectionTools(boolean bShown)

Specifies whether selection tools -- rectangle tool, circle tool, polygon tool, and point tool -- will be shown on the toolbar.

Parameters:

bShown - True if the selection tools should be visible. False if all selection tools should be hidden.

isShowSelectionTools

public boolean isShowSelectionTools()

Indicates whether selection tools -- rectangle tool, circle tool, polygon tool, and point tool -- is visible on the toolbar or not

Returns:

True if the selection tools is visible. False if the selection tools is hidden.

setShowZoomTools

public void setShowZoomTools(boolean bShown)

Specifies whether zoom in tool and zoom out tool will be shown on the toolbar.

Parameters:

bShown - True if the zoom in and zoom out tools are visible. False if the zoom in and zoom out tools are hidden.

isShowZoomTools

public boolean isShowZoomTools()

Indicates whether the zoom in and zoom out tools are visible or not.

Returns:

True if the zoom in and zoom out tools are visible. False if the zoom in and zoom out tools are hidden.

setShowDistanceTools

public void setShowDistanceTools(boolean bShown)

Specifies wheter distance tool and area tool will be shown on the toolbar

Parameters:

bShown - True if distance and area tools should be visible. False if distance and area tools should be hidden.

isShowDistanceTools

public boolean isShowDistanceTools()

Indicates whether the distance and area tools are visible or not.

Returns:

True if the distance and area tools are visible. False if the distance and area tools are hidden.

setShowSelectThemeDialog

public void setShowSelectThemeDialog(boolean bShown)

Specifies whether the select theme dialog will be visible on the view menu of the toolbar

Parameters:

bShown - True if the select theme dialog will be visible. False if it is hidden.

isShowSelectThemeDialog

public boolean isShowSelectThemeDialog()

Indicates whether the select theme dialog is visible on the view menu of the toolbar

Returns:

True if the select theme dialog is visible. False if it is hidden.

setShowSelectThemeMenuItem

public void setShowSelectThemeMenuItem(boolean bShown)

Specifies whether "select theme" menu item will be visible on the view menu of the toolbar

Parameters:

bShown - True if the "select theme" menu item should be visible. False if it should be hidden.

isShowSelectThemeMenuItem

public boolean isShowSelectThemeMenuItem()

Indicates whether "select theme" menu item is visible

Returns:

True if "select theme" menu item is visible. False if it is hidden

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component

Parameters:

styleClass - The styleClass for this component

getStyleClass

public java.lang.String getStyleClass()

Return the CSS style class for this component

Returns:

The styleClass of this component

setPartialTriggers

public void setPartialTriggers(java.lang.String[] ids)

Specifies the ids of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:

ids - The ids of the component

getPartialTriggers

public java.lang.String[] getPartialTriggers()

Return the ids of the components that should trigger a partial update.

Returns:

The ids of the components that would trigger a parital update.

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

isButtonSelected

public boolean isButtonSelected(java.lang.String buttonType)

For internal use only. Application developers should not use this

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class org.apache.myfaces.trinidad.component.UIXComponentBase

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object stateObj)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase