com.esri.adf.web.faces.taglib
Class OverviewTag

java.lang.Object
  javax.faces.webapp.UIComponentTagBase
      javax.faces.webapp.UIComponentClassicTagBase
          javax.faces.webapp.UIComponentELTag
              com.esri.adf.web.faces.taglib.OverviewTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class OverviewTag
extends javax.faces.webapp.UIComponentELTag

JSP tag for the OverviewControl.

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

bodyContent, pageContext, UNIQUE_ID_PREFIX

Fields inherited from class javax.faces.webapp.UIComponentTagBase

log

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Constructor Summary

OverviewTag()
Initializes the tag.

Method Summary

String	getComponentType() Returns the component type string.
String	getRendererType() Returns the renderer type.
void	release() Resets the attribute values to defaults.
void	setClientPostBack(javax.el.ValueExpression clientPostBack) Sets the client side post back for this control.
void	setHeight(javax.el.ValueExpression height) Sets the height of the control.
void	setLineColor(javax.el.ValueExpression lineColor) Sets the line color for this control.
void	setLineWidth(javax.el.ValueExpression lineWidth) Sets the line width for this control.
void	setMapId(javax.el.ValueExpression mapId) Sets the map control id associated with the control.
protected void	setProperties(javax.faces.component.UIComponent component) Sets the attributes of the OverviewControl from the tag attributes.
void	setStaticImageUrl(javax.el.ValueExpression staticImageUrl) Sets the URL of the image to be used in overview map.
void	setStyle(javax.el.ValueExpression style) Sets the style for this control.
void	setStyleClass(javax.el.ValueExpression styleClass) Sets the CSS class for this control.
void	setValue(javax.el.ValueExpression value) Sets the value binding expression for the overview.
void	setWidth(javax.el.ValueExpression width) Sets the width of the control.
void	setXslFile(javax.el.ValueExpression xslFileName) Sets the XSL file which renders the OverviewControl.

Methods inherited from class javax.faces.webapp.UIComponentELTag

createComponent, getELContext, hasBinding, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, setPageContext, setParent

Constructor Detail

OverviewTag

public OverviewTag()

Initializes the tag.

Method Detail

release

public void release()

Resets the attribute values to defaults.

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.faces.webapp.UIComponentELTag

getComponentType

public String getComponentType()

Returns the component type string.

Specified by:

getComponentType in class javax.faces.webapp.UIComponentTagBase

Returns:

String- the component-type as defined in the faces-config.xml file

getRendererType

public String getRendererType()

Returns the renderer type.

Specified by:

getRendererType in class javax.faces.webapp.UIComponentTagBase

Returns:

String- the renderer-type as defined in the faces-config.xml file

setProperties

protected void setProperties(javax.faces.component.UIComponent component)

Sets the attributes of the OverviewControl from the tag attributes.

Overrides:

setProperties in class javax.faces.webapp.UIComponentELTag

Parameters:

component - the component to override properties

setValue

public void setValue(javax.el.ValueExpression value)

Sets the value binding expression for the overview. The expression must evaluate to a WebOverview.

Parameters:

value - the value binding expression for the overview

setMapId

public void setMapId(javax.el.ValueExpression mapId)

Sets the map control id associated with the control.

Parameters:

mapId - the map control id.

setWidth

public void setWidth(javax.el.ValueExpression width)

Sets the width of the control.

Parameters:

width - the width in pixels

setHeight

public void setHeight(javax.el.ValueExpression height)

Sets the height of the control.

Parameters:

height - the height in pixels

setXslFile

public void setXslFile(javax.el.ValueExpression xslFileName)

Sets the XSL file which renders the OverviewControl. The XSL file needs to be located in the xsl directory of the WebApplication.

Parameters:

xslFileName - the XSL file name

setStyle

public void setStyle(javax.el.ValueExpression style)

Sets the style for this control.

Parameters:

style - the style value

setStyleClass

public void setStyleClass(javax.el.ValueExpression styleClass)

Sets the CSS class for this control.

Parameters:

styleClass - the CSS class name

setLineColor

public void setLineColor(javax.el.ValueExpression lineColor)

Sets the line color for this control.

Parameters:

lineColor - an HTML color string

setLineWidth

public void setLineWidth(javax.el.ValueExpression lineWidth)

Sets the line width for this control.

Parameters:

lineWidth - the width in pixels

setClientPostBack

public void setClientPostBack(javax.el.ValueExpression clientPostBack)

Sets the client side post back for this control.

Parameters:

clientPostBack - if true, the client side post back is supported

setStaticImageUrl

public void setStaticImageUrl(javax.el.ValueExpression staticImageUrl)

Sets the URL of the image to be used in overview map. The image must represent the full extent of the main map. If URL is not specified, the services associated with WebMap are used to generate the image.

 For Example,
   overview.setStaticImageUrl("http://localhost/mycontext/images/overview.png");
        [OR}
   overview.setStaticImageUrl("/images/overview.png");
 

Parameters:

staticImageUrl - the URL of the static image.