|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
com.esri.adf.web.faces.component.MapControl
public class MapControl
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 String |
COMPONENT_FAMILY
The standard component family for this component. |
static String |
COMPONENT_TYPE
The standard component type for this component. |
static String |
DEFAULT_XSL_FILE_NAME
The name of the XSL file used to render this control by default. |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
MapControl()
Initializes the MapControl. |
Method Summary | |
---|---|
ToolItem |
getActiveTool()
Returns the tool item for the active tool. |
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. |
String |
getStyle()
Returns the style attributes of toolbar control. |
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. |
URL |
getXslUrl()
Returns the URL of the XSL file used to render the control. |
boolean |
isInit()
Returns an indicator whether this control is initialized. |
boolean |
isShowCoordinateTracker()
Indicates whether the control should display the coordinate tracker. |
boolean |
isShowNavigator()
Indicates whether the control should display the navigator. |
boolean |
isShowZoomSlider()
Indicates whether the control should display the zoom slider. |
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,
Object state)
Restores the state of the control. |
Object |
saveState(javax.faces.context.FacesContext facesContext)
Saves the state of this control. |
void |
setActiveTool(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(String id)
|
void |
setInit(boolean init)
Sets an indicator whether to initialize the control. |
void |
setShowCoordinateTracker(boolean showCoordinateTracker)
Sets whether the control should display the coordinate tracker or not. |
void |
setShowNavigator(boolean showNavigator)
Sets whether the control should display the navigator or not. |
void |
setShowZoomSlider(boolean showZoomSlider)
Sets whether the control should display the zoom slider or not. |
void |
setStyle(String style)
Sets the default style for the toolbar control. |
void |
setStyleClass(String styleClass)
Sets the CSS class name where the CSS style attributes are defined. |
void |
setValueExpression(String name,
javax.el.ValueExpression binding)
Sets the value binding. |
void |
setWidth(int width)
Sets the width of the control. |
void |
setXslUrl(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, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId, getValueExpression |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public static final String DEFAULT_XSL_FILE_NAME
Constructor Detail |
---|
public MapControl()
Method Detail |
---|
public void setId(String id)
setId
in class javax.faces.component.UIComponentBase
public void processDecodes(javax.faces.context.FacesContext facesContext)
processDecodes
in class javax.faces.component.UIComponentBase
public String getFamily()
getFamily
in class javax.faces.component.UICommand
String
- the COMPONENT_FAMILY
protected javax.faces.render.Renderer getRenderer(javax.faces.context.FacesContext context)
getRenderer
in class javax.faces.component.UIComponentBase
context
- the FacesContext
Renderer
- the renderer objectpublic void processAction(javax.faces.event.ActionEvent event) throws javax.faces.event.AbortProcessingException
MapToolAction
class.
processAction
in interface javax.faces.event.ActionListener
event
- the ActionEvent
javax.faces.event.AbortProcessingException
- if the action can not be processedpublic MapEvent queueMapEvent(javax.faces.context.FacesContext facesContext)
MapEvent
is created and
populated with the event arguments containing the WebContext
, the active tool and the
ClientActionArgs
needed for that tool.
facesContext
- the FacesContext
public void setActiveTool(String toolKey)
toolKey
- the tool key, for example, "ZoomIn"public WebMap getWebMap()
WebMap
object associated with this control.
WebMap
- the WebMappublic WebScaleBar getWebScaleBar()
public ToolItemCollection getToolItemCollection()
ToolItemCollection
- the collection of toolspublic void setActiveTool(ToolItem activeTool)
activeTool
- the active ToolItem
public ToolItem getActiveTool()
ToolItem
- the active ToolItem
public void setInit(boolean init)
init
- if true, initialize the controlpublic boolean isInit()
public void setValueExpression(String name, javax.el.ValueExpression binding)
setValueExpression
in class javax.faces.component.UIComponent
name
- the name of the attribute or property for which to set a ValueBindingbinding
- the ValueBinding to set. If null, removes any currently set ValueBinding.public void setWidth(int width)
width
- the width in pixelspublic int getWidth()
public void setHeight(int height)
height
- the height in pixelspublic int getHeight()
public void setXslUrl(URL xslUrl)
xslUrl
- the URL of the XSL filepublic URL getXslUrl()
URL
- the URL objectpublic String getStyle()
String
- the style attributespublic void setStyle(String style)
style
- the default style for the toolbar controlpublic String getStyleClass()
String
- the CSS classpublic void setStyleClass(String styleClass)
styleClass
- the CSS classpublic boolean isShowZoomSlider()
public void setShowZoomSlider(boolean showZoomSlider)
showZoomSlider
- if true, shows the zoom sliderpublic boolean isShowNavigator()
public void setShowNavigator(boolean showNavigator)
showNavigator
- if true, shows the navigatorpublic boolean isShowCoordinateTracker()
public void setShowCoordinateTracker(boolean showCoordinateTracker)
showCoordinateTracker
- if true, shows the coordinate trackerpublic Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UICommand
facesContext
- the associated FacesContext
Object
- the object to be savedpublic void restoreState(javax.faces.context.FacesContext facesContext, Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UICommand
facesContext
- the associated FacesContextstate
- the object to restore the state of the control frompublic void processUpdates(javax.faces.context.FacesContext facesContext)
processUpdates
in class javax.faces.component.UIComponentBase
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |