com.esri.adf.web.faces.component
Class MapControl

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              com.esri.adf.web.faces.component.MapControl

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.StateHolder, javax.faces.event.ActionListener, javax.faces.event.FacesListener

public class MapControl
extends javax.faces.component.UICommand
implements javax.faces.event.ActionListener

The map control provides the display functionality of a map document served using GIS Server. Using the map control, you can navigate the map, for example, ZoomIn, ZoomOut, Pan etc.
The MapControl works with WebMap object. The MapRenderer class renders the control to the appropriate markup, and the MapTag class exposes the control as a JSP custom tag named map. In addition, events are exposed through MapEvent, and various map tool actions can be performed on the control.

Field Summary

static java.lang.String	COMPONENT_FAMILY The standard component family for this component.
static java.lang.String	COMPONENT_TYPE The standard component type for this component.
static java.lang.String	DEFAULT_XSL_FILE_NAME The name of the XSL file used to render this control by default.

Constructor Summary

MapControl()
Initializes the MapControl.

Method Summary

ToolItem	getActiveTool() Returns the tool item for the active tool.
java.lang.String	getFamily() Returns the family of this control.
int	getHeight() Returns the height of the control.
protected javax.faces.render.Renderer	getRenderer(javax.faces.context.FacesContext context) Returns a design-time renderer if the component is used in an IDE.
java.lang.String	getStyle() Returns the style attributes of toolbar control.
java.lang.String	getStyleClass() Returns the file name where the CSS style attributes are defined.
ToolItemCollection	getToolItemCollection() Returns the tool item collection.
WebMap	getWebMap() Returns the WebMap object associated with this control.
WebScaleBar	getWebScaleBar()
int	getWidth() Returns the width of the control.
java.net.URL	getXslUrl() Returns the URL of the XSL file used to render the control.
boolean	isInit() Returns an indicator whether this control is initialized.
void	processAction(javax.faces.event.ActionEvent event) Processes an action fired by this control.
void	processDecodes(javax.faces.context.FacesContext facesContext)
void	processUpdates(javax.faces.context.FacesContext facesContext)
MapEvent	queueMapEvent(javax.faces.context.FacesContext facesContext) Set the event arguments passed by the client and queues the action event.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state) Restores the state of the control.
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this control.
void	setActiveTool(java.lang.String toolKey) Sets the active tool for this control.
void	setActiveTool(ToolItem activeTool) Sets the active tool for this control.
void	setHeight(int height) Sets the height of the control.
void	setId(java.lang.String id)
void	setInit(boolean init) Sets an indicator whether to initialize the control.
void	setStyle(java.lang.String style) Sets the default style for the toolbar control.
void	setStyleClass(java.lang.String styleClass) Sets the CSS class name where the CSS style attributes are defined.
void	setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding) Sets the value binding.
void	setWidth(int width) Sets the width of the control.
void	setXslUrl(java.net.URL xslUrl) Sets the URL of the XSL file used to render the control.

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

DEFAULT_XSL_FILE_NAME

public static final java.lang.String DEFAULT_XSL_FILE_NAME

The name of the XSL file used to render this control by default.

See Also:

Constant Field Values

Constructor Detail

MapControl

public MapControl()

Initializes the MapControl. The renderer type is set and the control is registered as an ActionListener.

Method Detail

setId

public void setId(java.lang.String id)

Overrides:

setId in class javax.faces.component.UIComponentBase

processDecodes

public void processDecodes(javax.faces.context.FacesContext facesContext)

Overrides:

processDecodes in class javax.faces.component.UIComponentBase

getFamily

public java.lang.String getFamily()

Returns the family of this control.

Overrides:

getFamily in class javax.faces.component.UICommand

Returns:

String- the COMPONENT_FAMILY

getRenderer

protected javax.faces.render.Renderer getRenderer(javax.faces.context.FacesContext context)

Returns a design-time renderer if the component is used in an IDE.

Overrides:

getRenderer in class javax.faces.component.UIComponentBase

Parameters:

context - the FacesContext

Returns:

Renderer- the renderer object

processAction

public void processAction(javax.faces.event.ActionEvent event)
                   throws javax.faces.event.AbortProcessingException

Processes an action fired by this control. The map control delegates processing of this action to the active tool's MapToolAction class.

Specified by:

processAction in interface javax.faces.event.ActionListener

Parameters:

event - the ActionEvent

Throws:

javax.faces.event.AbortProcessingException - if the action can not be processed

queueMapEvent

public MapEvent queueMapEvent(javax.faces.context.FacesContext facesContext)

Set the event arguments passed by the client and queues the action event. A new MapEvent is created and populated with the event arguments containing the WebContext, the active tool and the ClientActionArgs needed for that tool.

Parameters:

facesContext - the FacesContext

Returns:

MapEventArgs- the map event arguments

setActiveTool

public void setActiveTool(java.lang.String toolKey)

Sets the active tool for this control.

Parameters:

toolKey - the tool key, for example, "ZoomIn"

getWebMap

public WebMap getWebMap()

Returns the WebMap object associated with this control.

Returns:

WebMap- the WebMap

getWebScaleBar

public WebScaleBar getWebScaleBar()

getToolItemCollection

public ToolItemCollection getToolItemCollection()

Returns the tool item collection.

Returns:

ToolItemCollection- the collection of tools

setActiveTool

public void setActiveTool(ToolItem activeTool)

Sets the active tool for this control.

Parameters:

activeTool - the active ToolItem

getActiveTool

public ToolItem getActiveTool()

Returns the tool item for the active tool.

Returns:

ToolItem- the active ToolItem

setInit

public void setInit(boolean init)

Sets an indicator whether to initialize the control.

Parameters:

init - if true, initialize the control

isInit

public boolean isInit()

Returns an indicator whether this control is initialized.

Returns:

boolean- if true, the control is initialized

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)

Sets the value binding. For the "value" attribute, checks if it is an instance of WebMap or not. If not, the method throws an ADFException. For all other cases, the method calls super.setValueBinding()

Overrides:

setValueBinding in class javax.faces.component.UIComponentBase

Parameters:

name - the name of the attribute or property for which to set a ValueBinding

binding - the ValueBinding to set. If null, removes any currently set ValueBinding.

setWidth

public void setWidth(int width)

Sets the width of the control.

Parameters:

width - the width in pixels

getWidth

public int getWidth()

Returns the width of the control.

Returns:

int- the width in pixels

setHeight

public void setHeight(int height)

Sets the height of the control.

Parameters:

height - the height in pixels

getHeight

public int getHeight()

Returns the height of the control.

Returns:

int- the height in pixels

setXslUrl

public void setXslUrl(java.net.URL xslUrl)

Sets the URL of the XSL file used to render the control.

Parameters:

xslUrl - the URL of the XSL file

getXslUrl

public java.net.URL getXslUrl()

Returns the URL of the XSL file used to render the control.

Returns:

URL- the URL object

getStyle

public java.lang.String getStyle()

Returns the style attributes of toolbar control.

Returns:

String- the style attributes

setStyle

public void setStyle(java.lang.String style)

Sets the default style for the toolbar control.

Parameters:

style - the default style for the toolbar control

getStyleClass

public java.lang.String getStyleClass()

Returns the file name where the CSS style attributes are defined.

Returns:

String- the CSS class

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS class name where the CSS style attributes are defined.

Parameters:

styleClass - the CSS class

saveState

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

Saves the state of this control.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UICommand

Parameters:

facesContext - the associated FacesContext

Returns:

Object- the object to be saved

restoreState

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

Restores the state of the control.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UICommand

Parameters:

facesContext - the associated FacesContext

state - the object to restore the state of the control from

processUpdates

public void processUpdates(javax.faces.context.FacesContext facesContext)

Overrides:

processUpdates in class javax.faces.component.UIComponentBase