|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.esri.arcgis.output.ExportPNG
public class ExportPNG
Class used to export maps to PNG (Portable Network Graphics) format.
Use the ExportPNG CoClass to export your map to PNG (Portable Network Graphics) format. PNG is a raster format designed for use on the Web. It supports 24-bit color and is compressed. PNG files also have the ability to define a transparent color. This allows part of the image to display as transparent in a web browser, allowing background images or colors to show through. This format is gaining popularity in the web design community.
The PNG format uses "lossless" compression, making it ideal for transfer to image editing applications where it may go through multiple edit and save cycles. Lossless compression guarantees no pixel data will be lost during the compression process.
| Constructor Summary | |
|---|---|
ExportPNG()
Constructs a ExportPNG using ArcGIS Engine. |
|
ExportPNG(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ExportPNG theExportPNG = (ExportPNG) obj; |
|
| Method Summary | |
|---|---|
void |
cleanup()
Cleanup should clean all temporary files, free used memory, etc... |
boolean |
equals(Object o)
Compare this object with another |
void |
finishExporting()
Shuts down the Exporter. |
IColor |
getBackgroundColor()
The background color of the Image. |
int |
getBiLevelThreshold()
The Threshold value for BiLevel images. |
static String |
getClsid()
getClsid. |
String |
getExportFileName()
The Export File Name. |
String |
getFilter()
Filter String used in the CFileDialog class. |
int |
getHeight()
The height of the Image. |
int |
getImageType()
Export Image Type. |
IEnvelope |
getMapExtent()
The Map Extent. |
double |
getMapRotation()
The Map rotation angle in degrees. |
String |
getName()
The Name of the Exporter. |
IEnvelope |
getPixelBounds()
The Export Bounds in Pixels (The Pixel Bounds of the Export surface). |
int |
getPriority()
Exporter's priority - the order of appearance in the user interface. |
double |
getResolution()
The Export Resolution. |
IColor |
getTransparentColor()
The color that is marked as transparent in the export image. |
int |
getWidth()
The width of the Image. |
int |
hashCode()
the hashcode for this object |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
boolean |
isInterlaceMode()
The interlaced PNG export mode. |
boolean |
isOutputWorldFile()
Indicates if a World File will be created. |
void |
restoreDefault()
Restore the default object settings. |
void |
restoreForCurrentUser(String bstrRegPath)
Restore object settings. |
void |
setBackgroundColor(IColor ppBackgroundColor)
The background color of the Image. |
void |
setBiLevelThreshold(int threshold)
The Threshold value for BiLevel images. |
void |
setExportFileName(String fileName)
The Export File Name. |
void |
setHeight(int pHeight)
The height of the Image. |
void |
setImageType(int pimageType)
Export Image Type. |
void |
setInterlaceMode(boolean interlace)
The interlaced PNG export mode. |
void |
setMapExtent(IEnvelope mapExtent)
The Map Extent. |
void |
setMapRotation(double mapRotAngle)
The Map rotation angle in degrees. |
void |
setOutputWorldFile(boolean outputWorldFile)
Indicates if a World File will be created. |
void |
setPixelBounds(IEnvelope pixelBounds)
The Export Bounds in Pixels (The Pixel Bounds of the Export surface). |
void |
setResolution(double res)
The Export Resolution. |
void |
setStepProgressorByRef(IStepProgressor rhs1)
Export will update a Progress Bar if StepProgressor is not NULL. |
void |
setTrackCancelByRef(ITrackCancel rhs1)
Export will react on Cancel if TrackCancel is not NULL. |
void |
setTransparentColor(IColor color)
The color that is marked as transparent in the export image. |
void |
setWidth(int pWidth)
The width of the Image. |
int |
startExporting()
Initializes the Exporter. |
void |
storeForCurrentUser(String bstrRegPath)
Store object settings. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public ExportPNG()
throws IOException,
UnknownHostException
IOException - if there are interop problems
UnknownHostException - if there are interop problems
public ExportPNG(Object obj)
throws IOException
ExportPNG theExportPNG = (ExportPNG) obj;
obj to ExportPNG.
obj - an object returned from ArcGIS Engine or Server
IOException - if there are interop problems| Method Detail |
|---|
public static String getClsid()
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void setImageType(int pimageType)
throws IOException,
AutomationException
setImageType in interface IExportImagepimageType - A com.esri.arcgis.output.esriExportImageType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getImageType()
throws IOException,
AutomationException
getImageType in interface IExportImageIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBackgroundColor(IColor ppBackgroundColor)
throws IOException,
AutomationException
setBackgroundColor in interface IExportImageppBackgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IColor getBackgroundColor()
throws IOException,
AutomationException
getBackgroundColor in interface IExportImageIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setWidth(int pWidth)
throws IOException,
AutomationException
setWidth in interface IExportImagepWidth - The pWidth (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getWidth()
throws IOException,
AutomationException
getWidth in interface IExportImageIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setHeight(int pHeight)
throws IOException,
AutomationException
setHeight in interface IExportImagepHeight - The pHeight (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getHeight()
throws IOException,
AutomationException
getHeight in interface IExportImageIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setInterlaceMode(boolean interlace)
throws IOException,
AutomationException
setInterlaceMode in interface IExportPNGinterlace - The interlace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isInterlaceMode()
throws IOException,
AutomationException
isInterlaceMode in interface IExportPNGIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTransparentColor(IColor color)
throws IOException,
AutomationException
setTransparentColor in interface IExportPNGcolor - A reference to a com.esri.arcgis.display.IColor (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IColor getTransparentColor()
throws IOException,
AutomationException
getTransparentColor in interface IExportPNGIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBiLevelThreshold(int threshold)
throws IOException,
AutomationException
setBiLevelThreshold in interface IExportPNGthreshold - The threshold (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getBiLevelThreshold()
throws IOException,
AutomationException
getBiLevelThreshold in interface IExportPNGIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
getName in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getFilter()
throws IOException,
AutomationException
This method is primarily used for defining the extension of the export file name within the Export Map dialog. The string contained in this value is a null-terminated pattern string that follows the standard for a Windows Open and Save As dialog filter. The value of this property can change according to the state of the export object. An ExportSVG object, for example, returns "SVG (*.svg)|*.svg" when its compression property is False, and "Compressed SVG (*.svgz)|*.svgz" when the compression property is True. This makes the Filter ideal for automatically assigning the appropriate file name extension for an export file.
getFilter in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getPriority()
throws IOException,
AutomationException
Primarily used by export dialogs for ordering the appearance of export formats in the 'Save As...' pulldown list. By ordering through this property, the export dialog can group similar formats together. For example, all raster export formats are grouped together in the 'Save As...' list.
getPriority in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setStepProgressorByRef(IStepProgressor rhs1)
throws IOException,
AutomationException
setStepProgressorByRef in interface IExportrhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTrackCancelByRef(ITrackCancel rhs1)
throws IOException,
AutomationException
setTrackCancelByRef in interface IExportrhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPixelBounds(IEnvelope pixelBounds)
throws IOException,
AutomationException
setPixelBounds in interface IExportpixelBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getPixelBounds()
throws IOException,
AutomationException
The PixelBounds represents the height and width of the export image in device units (usually pixels for a export file). To set up values to use in this property, get the height and width of the image draw to screen. Then multiply each dimension by the ratio of the output resolution to screen resolution.
getPixelBounds in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExportFileName(String fileName)
throws IOException,
AutomationException
setExportFileName in interface IExportfileName - The fileName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getExportFileName()
throws IOException,
AutomationException
You must assign a value to the ExportFileName property before calling the IExport::StartExporting() method. There are two exceptions to this. If IExport is controlling a ExportBMP or ExportEMF object, you can assign an empty string to the ExportFileName property without an error being raised on StartExporting(). This is to allow cases where the application will use the export object as a intermediate container for a drawing, and won't be written to an export file.
getExportFileName in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setResolution(double res)
throws IOException,
AutomationException
setResolution in interface IExportres - The res (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getResolution()
throws IOException,
AutomationException
getResolution in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int startExporting()
throws IOException,
AutomationException
The StartExporting method causes the export object to allocate memory for the export based on resolution, bit depth, and pixel bounds. The method returns a long that represents the hDC (Windows GDI Device Context handle) of the export object. After this method is called, the export object is ready to receive GDI draw instructions directed to its hDC.
startExporting in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void finishExporting()
throws IOException,
AutomationException
finishExporting in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void cleanup()
throws IOException,
AutomationException
cleanup in interface IExportIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMapExtent(IEnvelope mapExtent)
throws IOException,
AutomationException
setMapExtent in interface IWorldFileSettingsmapExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getMapExtent()
throws IOException,
AutomationException
The MapExtent property holds the envelope that will be used during creation of a world file or writing of a GeoTIFF header. Get the map extent envelope from the Extent property IActiveView on a Map object.
getMapExtent in interface IWorldFileSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutputWorldFile(boolean outputWorldFile)
throws IOException,
AutomationException
setOutputWorldFile in interface IWorldFileSettingsoutputWorldFile - The outputWorldFile (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isOutputWorldFile()
throws IOException,
AutomationException
isOutputWorldFile in interface IWorldFileSettingsIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMapRotation(double mapRotAngle)
throws IOException,
AutomationException
setMapRotation in interface IWorldFileSettings2mapRotAngle - The mapRotAngle (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMapRotation()
throws IOException,
AutomationException
When the map is part of a rotated dataframe, assign the dataframe rotation angle (in degrees) to this property. This will ensure that the world file or GeoTIFF header appropriately accounts for rotation of the image. The rotation angle of a map can be read from IDisplayTransformation::Rotation. The display transformation of the active view can be accessed via IActiveView::ScreenDisplay.
getMapRotation in interface IWorldFileSettings2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void restoreForCurrentUser(String bstrRegPath)
throws IOException,
AutomationException
restoreForCurrentUser in interface ISettingsInRegistrybstrRegPath - The bstrRegPath (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void storeForCurrentUser(String bstrRegPath)
throws IOException,
AutomationException
storeForCurrentUser in interface ISettingsInRegistrybstrRegPath - The bstrRegPath (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void restoreDefault()
throws IOException,
AutomationException
restoreDefault in interface ISettingsInRegistryIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws IOException,
AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||