|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.adf.web.wms.data.WMSOverviewFunctionality
public class WMSOverviewFunctionality
Represents the overview functionality implementation for the WMS Resource.
Field Summary |
---|
Fields inherited from interface com.esri.adf.web.data.OverviewFunctionality |
---|
FUNCTIONALITY_NAME |
Constructor Summary | |
---|---|
WMSOverviewFunctionality()
|
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 . |
WMSMapResource |
getResource()
Returns the GISResource associated with this functionality. |
List<String> |
getVisibleLayers()
Gets the list of layers that will be visible in the overview map. |
com.esri.wms.client.Map |
getWmsMap()
|
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 |
setDisabled(boolean disabled)
If true, this overview functionality is disabled. |
void |
setVisibleLayers(List<String> layers)
Sets the layers that will be included in the overview map. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public WMSOverviewFunctionality()
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 WMSMapResource 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 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 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 com.esri.wms.client.Map getWmsMap()
public List<String> getVisibleLayers()
WMSMapFunctionality.getLayerSubset()
. By default the visibleLayers
is null, the overview honors the visibility setting in the map functionality.
public void setVisibleLayers(List<String> layers)
<managed-bean> <managed-bean-name>wmsOverview</managed-bean-name> <managed-bean-class>com.esri.adf.web.wms.data.WMSOverviewFunctionality </managed-bean-class> <managed-bean-scope>none</managed-bean-scope> <managed-property> <property-name>visibleLayers</property-name> <list-entries> <value>countries</value> <value>cities</value> </list-entries> </managed-property> </managed-bean>
layers
- The layers to set.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |