|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.adf.web.aims.data.AIMSOverviewFunctionality
public class AIMSOverviewFunctionality
Represents the overview functionality implementation for the ArcIMS services.
The AIMSOverviewFunctionality maintains the reference to the
Map
object.
When initFunctionality(com.esri.adf.web.data.GISResource)
method is called, the GET_SERVICE_INFO request is sent to the ArcIMS Server.
Calling exportImage()
, the GET_IMAGE AXL request is sent to the ArcIMS Server.
ArcIMS Overview Functionality can be added using JSF managed bean configuration as shown below,
<managed-bean> <managed-bean-name>aimsOverview</managed-bean-name> <managed-bean-class>com.esri.adf.web.aims.data.AIMSOverviewFunctionality</managed-bean-class> <managed-bean-scope>none</managed-bean-scope> </managed-bean>
Field Summary |
---|
Fields inherited from interface com.esri.adf.web.data.OverviewFunctionality |
---|
FUNCTIONALITY_NAME |
Constructor Summary | |
---|---|
AIMSOverviewFunctionality()
|
Method Summary | |
---|---|
void |
destroyFunctionality()
The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. |
InputStream |
exportImage()
Exports this overview map for the extent indicated by the WebOverview . |
String |
getDefaultDataFrame()
Returns the default dataframe name. |
int |
getDPI()
Returns the DPI of the overview map. |
com.esri.aims.mtier.model.map.Map |
getMap()
Returns the Map object. |
AIMSMapResource |
getResource()
Returns the GISResource associated with this functionality. |
void |
initFunctionality(GISResource resource)
Initializes an instance of the overview functionality for this resource. |
boolean |
isDisabled()
Returns true if this overview functionality is disabled. |
void |
setDefaultDataFrame(String defaultDataFrame)
Sets the default data frame in which the overview functionality should work with. |
void |
setDisabled(boolean disabled)
If true, this overview functionality is disabled. |
void |
setDPI(int dpi)
Sets the DPI(dots per square inch) for the overview functionality output image. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AIMSOverviewFunctionality()
Method Detail |
---|
public void initFunctionality(GISResource resource)
initFunctionality
in interface GISFunctionality
resource
- the GISResource
that this functionality supportsGISResource.init(WebContext)
public void destroyFunctionality()
GISFunctionality
The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This
method is called by the GISResource
when the resource itself is being destroyed.
The functionality is no longer usable after this method has been called.
destroyFunctionality
in interface GISFunctionality
GISResource.destroy()
public AIMSMapResource getResource()
GISFunctionality
Returns the GISResource
associated with this functionality.
The resource passed to GISFunctionality.initFunctionality(GISResource)
is maintained as a class variable and is accessible
through this method.
getResource
in interface GISFunctionality
GISResource
associated with this functionalitypublic InputStream exportImage()
OverviewFunctionality
Exports this overview map for the extent indicated by the WebOverview
. Implementations should ensure the
following:
WebContext
.
WebOverview
. The
WebOverview.getDrawExtent()
method can be used to get this extent.
The WebOverview
calls this method on all its overview functionalities and eventually fuses all the exported
maps before streaming it to the user. This method is called by the WebOverview
in these scenarios:
WebOverview
is initialized
exportImage
in interface OverviewFunctionality
java.io.InputStream
to the exported imagepublic boolean isDisabled()
OverviewFunctionality
Returns true if this overview functionality is disabled. If a overview functionality is disabled, the
WebOverview
will not call the OverviewFunctionality.exportImage()
on that functionality while it is disabled.
A overview functionality is typically disabled by using the "Disable Overview" context menu item on the resource node in the Table of Contents control. Similarly, the functionality can be enabled by using "Enable Overview".
isDisabled
in interface OverviewFunctionality
public void setDisabled(boolean disabled)
OverviewFunctionality
If true, this overview functionality is disabled. If a overview functionality is disabled, the WebOverview
will not call the OverviewFunctionality.exportImage()
on that functionality while it is disabled.
A overview functionality is typically disabled by using the "Disable Overview" context menu item on the resource node in the Table of Contents control. Similarly, the functionality can be enabled by using "Enable Overview".
setDisabled
in interface OverviewFunctionality
disabled
- true if this overview functionality is disabledpublic com.esri.aims.mtier.model.map.Map getMap()
Map
object.
public void setDPI(int dpi)
dpi
- the DPI for the overview functionality output image.public int getDPI()
public void setDefaultDataFrame(String defaultDataFrame)
This property is valid only if the associated resource service type is ImageServerArcMap.
defaultDataFrame
- the default dataframe name.public String getDefaultDataFrame()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |