com.esri.arcgis.carto
Interface IMapServerLayout

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMapServerLayoutProxy, MapServer

public interface IMapServerLayout
extends java.io.Serializable

COM Interface 'IMapServerLayout'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that serve layout components of maps.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID545329c0_300b_46f3_9fb3_71f30ecfde62
static int	xxDummy Deprecated. Internal use only

Method Summary

ILayoutImage	exportLayout(IPageDescription pageDesc, IImageDescription imageDesc) Generates an image of the layout, based on the given page description object, and writes the image to a specified file on disk.
IImageResult	exportLegend(ILegend legend, IMapDescription mapDesc, IImageDisplay pMapDisplay, IColor backgroundColor, IImageDescription imageDesc) Exports a legend to an image file.
IImageResult	exportNorthArrow(INorthArrow arrow, IMapDescription mapDesc, IColor backgroundColor, IImageDescription imageDesc) Exports a north arrow to an image file.
IImageResult	exportScaleBar(IScaleBar scalebar, IMapDescription mapDesc, IImageDisplay pMapDisplay, IColor backgroundColor, IImageDescription imageDesc) Exports a scale bar to an image file.
void	fromPagePoints(IEnvelope pageExtent, IImageDisplay pageDisplay, IPointCollection pagePoints, ILongArray[] screenXValues, ILongArray[] screenYValues) Converts a page coordinate to a screen location.
IPageDescription	getDefaultPageDescription() The default page settings.
IPointCollection	toPagePoints(IEnvelope pageExtent, IImageDisplay pageDisplay, ILongArray screenXValues, ILongArray screenYValues) Converts a screen location to a page coordinate.

Field Detail

IID545329c0_300b_46f3_9fb3_71f30ecfde62

static final int IID545329c0_300b_46f3_9fb3_71f30ecfde62

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getDefaultPageDescription

IPageDescription getDefaultPageDescription()
                                           throws java.io.IOException,
                                                  AutomationException

The default page settings.

Returns:

A reference to a com.esri.arcgis.carto.IPageDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportLayout

ILayoutImage exportLayout(IPageDescription pageDesc,
                          IImageDescription imageDesc)
                          throws java.io.IOException,
                                 AutomationException

Generates an image of the layout, based on the given page description object, and writes the image to a specified file on disk. Supported file types are: 'bmp', 'jpg', 'tif', 'png'/'png8', 'png24', 'emf', 'ps', 'pdf', 'ai', 'gif', and 'svg'/'svgz'.

Parameters:

pageDesc - A reference to a com.esri.arcgis.carto.IPageDescription (in)

imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)

Returns:

A reference to a com.esri.arcgis.carto.ILayoutImage

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportLegend

IImageResult exportLegend(ILegend legend,
                          IMapDescription mapDesc,
                          IImageDisplay pMapDisplay,
                          IColor backgroundColor,
                          IImageDescription imageDesc)
                          throws java.io.IOException,
                                 AutomationException

Exports a legend to an image file. The client can create the legend object and set its desired properties appropriately. If legend is Nothing/Null, a default legend will be generated.

Parameters:

legend - A reference to a com.esri.arcgis.carto.ILegend (in)

mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)

pMapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageResult

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportScaleBar

IImageResult exportScaleBar(IScaleBar scalebar,
                            IMapDescription mapDesc,
                            IImageDisplay pMapDisplay,
                            IColor backgroundColor,
                            IImageDescription imageDesc)
                            throws java.io.IOException,
                                   AutomationException

Exports a scale bar to an image file. The client can create the scaleBar object and set its desired properties appropriately. If scaleBar is Nothing/Null, a default scale bar will be generated.

Parameters:

scalebar - A reference to a com.esri.arcgis.carto.IScaleBar (in)

mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)

pMapDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageResult

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportNorthArrow

IImageResult exportNorthArrow(INorthArrow arrow,
                              IMapDescription mapDesc,
                              IColor backgroundColor,
                              IImageDescription imageDesc)
                              throws java.io.IOException,
                                     AutomationException

Exports a north arrow to an image file. The client can create the arrow object and set its desired properties appropriately. If arrow is Nothing/Null, a default north arrow will be generated.

Parameters:

arrow - A reference to a com.esri.arcgis.carto.INorthArrow (in)

mapDesc - A reference to a com.esri.arcgis.carto.IMapDescription (in)

backgroundColor - A reference to a com.esri.arcgis.display.IColor (in)

imageDesc - A reference to a com.esri.arcgis.carto.IImageDescription (in)

Returns:

A reference to a com.esri.arcgis.carto.IImageResult

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toPagePoints

IPointCollection toPagePoints(IEnvelope pageExtent,
                              IImageDisplay pageDisplay,
                              ILongArray screenXValues,
                              ILongArray screenYValues)
                              throws java.io.IOException,
                                     AutomationException

Converts a screen location to a page coordinate.

Parameters:

pageExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pageDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)

screenXValues - A reference to a com.esri.arcgis.system.ILongArray (in)

screenYValues - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPointCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fromPagePoints

void fromPagePoints(IEnvelope pageExtent,
                    IImageDisplay pageDisplay,
                    IPointCollection pagePoints,
                    ILongArray[] screenXValues,
                    ILongArray[] screenYValues)
                    throws java.io.IOException,
                           AutomationException

Converts a page coordinate to a screen location.

Parameters:

pageExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

pageDisplay - A reference to a com.esri.arcgis.carto.IImageDisplay (in)

pagePoints - A reference to a com.esri.arcgis.geometry.IPointCollection (in)

screenXValues - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)

screenYValues - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.