|
|||||||||
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.OverviewControl
public class OverviewControl
The overview control is similar to a map control. However, the purpose of the overview map is to provide a point of
reference for the area displayed on its associated map control. The overview control always shows the map at full
extent. A small box on the overview map represents the currently displayed area on its associated map control. You
can interactively move this box around to pan the area displayed in the map control.
The overview control works with WebOverview
object. The actual WebOverview object is created by the parent
context control. The OverviewEvent
object is used by the control to extract the point on the overview map to
center the overview rectangle. The OverviewRenderer
class renders the
control to the appropriate markup, and the OverviewTag
class exposes the
control as a JSP custom tag named overview.
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 | |
---|---|
OverviewControl()
Initializes the OverviewControl. |
Method Summary | |
---|---|
String |
getFamily()
Returns the family of this control. |
int |
getHeight()
Returns the height of the control. |
String |
getLineColor()
Returns the color of the line. |
int |
getLineWidth()
Returns the width of the line. |
String |
getMapId()
Returns the map control id associated with 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 |
getStaticImageUrl()
Returns the URL of the image to be used in overview map. |
String |
getStyle()
Returns the style attributes of toolbar control. |
String |
getStyleClass()
Returns the file name where the CSS style attributes are defined. |
WebOverview |
getWebOverview()
Returns the WebOverview object associated with this control. |
int |
getWidth()
Returns the width of the control. |
URL |
getXslUrl()
Returns the URL of the XSL file used to render the control. |
boolean |
isClientPostBack()
Indicates whether the control supports client side post back. |
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 |
processUpdates(javax.faces.context.FacesContext facesContext)
|
OverviewEvent |
queueOverviewEvent(javax.faces.context.FacesContext facesContext,
int mode,
int minX,
int minY,
int maxX,
int maxY)
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 |
setClientPostBack(boolean clientPostBack)
Sets whether the control supports client side post back. |
void |
setHeight(int height)
Sets the height of the control. |
void |
setInit(boolean init)
Sets an indicator whether to initialize the control. |
void |
setLineColor(String lineColor)
Sets the line color for this control. |
void |
setLineWidth(int lineWidth)
Sets the line width for this control. |
void |
setMapId(String mapControlId)
Sets the map control id associated with the control. |
void |
setStaticImageUrl(String staticImageUrl)
Sets the URL of the image to be used in overview map. |
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 to be displayed. |
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, processDecodes, processRestoreState, processSaveState, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, 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 OverviewControl()
Method Detail |
---|
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
WebOverview
.
processAction
in interface javax.faces.event.ActionListener
event
- the ActionEvent
javax.faces.event.AbortProcessingException
- if the action can not be processedpublic OverviewEvent queueOverviewEvent(javax.faces.context.FacesContext facesContext, int mode, int minX, int minY, int maxX, int maxY)
OverviewEvent
is created
and populated with the event arguments containing the WebContext
and the coordinate
to center at.
facesContext
- the FacesContext
mode
- the action to perform in the map controlminX
- the minx value in screen coordinatesminY
- the miny value in screen coordinatesmaxX
- the maxx value in screen coordinatesmaxY
- the maxy value in screen coordinates
OverviewEvent
- the overview event argumentspublic WebOverview getWebOverview()
WebOverview
object associated with this control.
WebOverview
- the WebOverviewpublic 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, remove any currently set ValueBinding.public String getMapId()
String
- the map control idpublic void setMapId(String mapControlId)
mapControlId
- the map control id.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 isClientPostBack()
public void setClientPostBack(boolean clientPostBack)
clientPostBack
- if true, the client side post back is supportedpublic void setLineColor(String lineColor)
lineColor
- an HTML color stringpublic String getLineColor()
String
- the line colorpublic void setLineWidth(int lineWidth)
lineWidth
- the line width in pixelspublic int getLineWidth()
public void setStaticImageUrl(String staticImageUrl)
WebMap
are used to generate the
image.
For Example, overview.setStaticImageUrl("http://localhost/mycontext/images/overview.png"); [OR} overview.setStaticImageUrl("/images/overview.png");
staticImageUrl
- the URL of the static image.public String getStaticImageUrl()
public 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 |