com.esri.arcgis.carto
Class IMapServerObjects3Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IMapServerObjects3Proxy
All Implemented Interfaces:
IMapServerObjects3, Externalizable, Serializable

public class IMapServerObjects3Proxy
extends com.esri.arcgis.interop.Dispatch
implements IMapServerObjects3, Serializable

Provides access to core objects contained within the map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IMapServerObjects3Proxy()
           
  IMapServerObjects3Proxy(Object obj)
           
protected IMapServerObjects3Proxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void applyMapDescription(IMapDescription mapDescription, IImageDisplay mapDisplay)
          Applies the current state of the map description to the map server object.
 ILayer getLayer(String mapName, int layerID)
          The layer specified by the map name and layer ID.
 int getLayerID(String mapName, ILayer pLayer)
          The layer specified by the map name and layer ID.
 IMap getMap(String mapName)
          The map corresponding to the specified map name.
 IPageLayout getPageLayout()
          The page layout object for the current map document.
 ITable getStandaloneTable(String mapName, int standaloneTableID)
          The table specified by the map name and table ID.
 int getStandaloneTableID(String mapName, ITable pTable)
          The layer specified by the map name and standalone table ID.
 Picture getThumbnail()
          The thumbnail stored in the map document.
 void refreshServerObjects()
          Updates the server info based on the current state of the underlying fine-grained objects.
 void removeListener(String iidStr, Object theListener)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

IMapServerObjects3Proxy

public IMapServerObjects3Proxy()

IMapServerObjects3Proxy

public IMapServerObjects3Proxy(Object obj)
                        throws IOException
Throws:
IOException

IMapServerObjects3Proxy

protected IMapServerObjects3Proxy(Object obj,
                                  String iid)
                           throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getStandaloneTableID

public int getStandaloneTableID(String mapName,
                                ITable pTable)
                         throws IOException,
                                AutomationException
The layer specified by the map name and standalone table ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getStandaloneTableID in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStandaloneTable

public ITable getStandaloneTable(String mapName,
                                 int standaloneTableID)
                          throws IOException,
                                 AutomationException
The table specified by the map name and table ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getStandaloneTable in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
standaloneTableID - The standaloneTableID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerID

public int getLayerID(String mapName,
                      ILayer pLayer)
               throws IOException,
                      AutomationException
The layer specified by the map name and layer ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getLayerID in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap(String mapName)
            throws IOException,
                   AutomationException
The map corresponding to the specified map name. Pass in a blank string for mapName to get the default map (active data frame).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getMap in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
Returns:
A reference to a com.esri.arcgis.carto.IMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(String mapName,
                       int layerID)
                throws IOException,
                       AutomationException
The layer specified by the map name and layer ID. If the mapName is blank, the default map (active data frame) will be assumed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getLayer in interface IMapServerObjects3
Parameters:
mapName - The mapName (in)
layerID - The layerID (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws IOException,
                                 AutomationException
The page layout object for the current map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPageLayout in interface IMapServerObjects3
Returns:
A reference to a com.esri.arcgis.carto.IPageLayout
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThumbnail

public Picture getThumbnail()
                     throws IOException,
                            AutomationException
The thumbnail stored in the map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getThumbnail in interface IMapServerObjects3
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshServerObjects

public void refreshServerObjects()
                          throws IOException,
                                 AutomationException
Updates the server info based on the current state of the underlying fine-grained objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
refreshServerObjects in interface IMapServerObjects3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applyMapDescription

public void applyMapDescription(IMapDescription mapDescription,
                                IImageDisplay mapDisplay)
                         throws IOException,
                                AutomationException
Applies the current state of the map description to the map server object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
applyMapDescription in interface IMapServerObjects3
Parameters:
mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)
mapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.