|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.esri.arcgis.output.ExportGIF
Class used to export maps to GIF (Graphics Interchange Format).
Use the ExportGIF CoClass to export your map to GIF (Graphics Interchange Format) format. GIF files are a standard raster format for use on the Web. GIFs cannot contain more than 256 colors (8 bits per pixel), which makes them smaller than other file formats. They are a good choice for maps that contain a limited number of colors, but may not display raster data correctly due to the color limitation. GIF 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 backgrounds images or colors to show through.
| Constructor Summary | |
ExportGIF()
Constructs a ExportGIF using ArcGIS Engine. |
|
ExportGIF(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. |
|
| Method Summary | |
void |
cleanup()
Cleanup should clean all temporary files, free used memory, etc... |
boolean |
equals(java.lang.Object o)
Compare this object with another |
void |
finishExporting()
Shuts down the Exporter. |
IExport |
getAsIExport()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
IExportGIF |
getAsIExportGIF()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
IExportImage |
getAsIExportImage()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
ISettingsInRegistry |
getAsISettingsInRegistry()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
ISupportErrorInfo |
getAsISupportErrorInfo()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
IWorldFileSettings |
getAsIWorldFileSettings()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
IWorldFileSettings2 |
getAsIWorldFileSettings2()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed. |
IColor |
getBackgroundColor()
The background color of the Image. |
int |
getBiLevelThreshold()
The Threshold value for BiLevel images. |
static java.lang.String |
getClsid()
|
int |
getCompressionType()
The GIF Compression type. |
java.lang.String |
getExportFileName()
The Export File Name. |
java.lang.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. |
java.lang.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)
Supported Platforms |
boolean |
isInterlaceMode()
The interlaced GIF export mode. |
boolean |
isOutputWorldFile()
Indicates if a World File will be created. |
void |
restoreDefault()
Restore the default object settings. |
void |
restoreForCurrentUser(java.lang.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 |
setCompressionType(int type)
The GIF Compression type. |
void |
setExportFileName(java.lang.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 GIF 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(java.lang.String bstrRegPath)
Store object settings. |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public ExportGIF()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems
public ExportGIF(java.lang.Object obj)
throws java.io.IOException
obj to ExportGIF. ExportGIF theExportGIF = (ExportGIF) obj;
obj - an object returned from ArcGIS Engine or Server
java.io.IOException - if there are interop problems| Method Detail |
public static java.lang.String getClsid()
public IExportImage getAsIExportImage()
public IExportGIF getAsIExportGIF()
public IExport getAsIExport()
public IWorldFileSettings getAsIWorldFileSettings()
public IWorldFileSettings2 getAsIWorldFileSettings2()
public ISettingsInRegistry getAsISettingsInRegistry()
public ISupportErrorInfo getAsISupportErrorInfo()
public boolean equals(java.lang.Object o)
public int hashCode()
public void setImageType(int pimageType)
throws java.io.IOException,
AutomationException
IExportImage
setImageType in interface IExportImagepimageType - A com.esri.arcgis.output.esriExportImageType constant (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getImageType()
throws java.io.IOException,
AutomationException
IExportImage
getImageType in interface IExportImageAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setBackgroundColor(IColor ppBackgroundColor)
throws java.io.IOException,
AutomationException
IExportImage
setBackgroundColor in interface IExportImageppBackgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IColor getBackgroundColor()
throws java.io.IOException,
AutomationException
IExportImage
getBackgroundColor in interface IExportImageAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setWidth(int pWidth)
throws java.io.IOException,
AutomationException
IExportImage
setWidth in interface IExportImagepWidth - The pWidth (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getWidth()
throws java.io.IOException,
AutomationException
IExportImage
getWidth in interface IExportImageAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setHeight(int pHeight)
throws java.io.IOException,
AutomationException
IExportImage
setHeight in interface IExportImagepHeight - The pHeight (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getHeight()
throws java.io.IOException,
AutomationException
IExportImage
getHeight in interface IExportImageAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setInterlaceMode(boolean interlace)
throws java.io.IOException,
AutomationException
IExportGIF
setInterlaceMode in interface IExportGIFinterlace - The interlace (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isInterlaceMode()
throws java.io.IOException,
AutomationException
IExportGIF
isInterlaceMode in interface IExportGIFjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setCompressionType(int type)
throws java.io.IOException,
AutomationException
IExportGIF
setCompressionType in interface IExportGIFtype - A com.esri.arcgis.output.esriGIFCompression constant (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getCompressionType()
throws java.io.IOException,
AutomationException
IExportGIF
getCompressionType in interface IExportGIFjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setTransparentColor(IColor color)
throws java.io.IOException,
AutomationException
IExportGIF
setTransparentColor in interface IExportGIFcolor - A reference to a com.esri.arcgis.display.IColor (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IColor getTransparentColor()
throws java.io.IOException,
AutomationException
IExportGIF
getTransparentColor in interface IExportGIFjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBiLevelThreshold(int threshold)
throws java.io.IOException,
AutomationException
IExportGIF
setBiLevelThreshold in interface IExportGIFthreshold - The threshold (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getBiLevelThreshold()
throws java.io.IOException,
AutomationException
IExportGIF
getBiLevelThreshold in interface IExportGIFAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getName()
throws java.io.IOException,
AutomationException
IExport
getName in interface IExportjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public java.lang.String getFilter()
throws java.io.IOException,
AutomationException
IExportThis 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 IExportAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int getPriority()
throws java.io.IOException,
AutomationException
IExportPrimarily 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 IExportjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setStepProgressorByRef(IStepProgressor rhs1)
throws java.io.IOException,
AutomationException
IExport
setStepProgressorByRef in interface IExportrhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setTrackCancelByRef(ITrackCancel rhs1)
throws java.io.IOException,
AutomationException
IExport
setTrackCancelByRef in interface IExportrhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setPixelBounds(IEnvelope pixelBounds)
throws java.io.IOException,
AutomationException
IExport
setPixelBounds in interface IExportpixelBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public IEnvelope getPixelBounds()
throws java.io.IOException,
AutomationException
IExport
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 IExportjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setExportFileName(java.lang.String fileName)
throws java.io.IOException,
AutomationException
IExport
setExportFileName in interface IExportfileName - The fileName (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public java.lang.String getExportFileName()
throws java.io.IOException,
AutomationException
IExportYou 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 IExportAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setResolution(double res)
throws java.io.IOException,
AutomationException
IExport
setResolution in interface IExportres - The res (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getResolution()
throws java.io.IOException,
AutomationException
IExport
getResolution in interface IExportAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public int startExporting()
throws java.io.IOException,
AutomationException
IExportThe 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 IExportAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void finishExporting()
throws java.io.IOException,
AutomationException
IExport
finishExporting in interface IExportAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void cleanup()
throws java.io.IOException,
AutomationException
IExport
cleanup in interface IExportAutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void setMapExtent(IEnvelope mapExtent)
throws java.io.IOException,
AutomationException
IWorldFileSettings
setMapExtent in interface IWorldFileSettingsmapExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getMapExtent()
throws java.io.IOException,
AutomationException
IWorldFileSettings
getMapExtent in interface IWorldFileSettingsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setOutputWorldFile(boolean outputWorldFile)
throws java.io.IOException,
AutomationException
IWorldFileSettings
setOutputWorldFile in interface IWorldFileSettingsoutputWorldFile - The outputWorldFile (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public boolean isOutputWorldFile()
throws java.io.IOException,
AutomationException
IWorldFileSettings
isOutputWorldFile in interface IWorldFileSettingsjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMapRotation(double mapRotAngle)
throws java.io.IOException,
AutomationException
IWorldFileSettings2
setMapRotation in interface IWorldFileSettings2mapRotAngle - The mapRotAngle (in)
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public double getMapRotation()
throws java.io.IOException,
AutomationException
IWorldFileSettings2When 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 IWorldFileSettings2java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void restoreForCurrentUser(java.lang.String bstrRegPath)
throws java.io.IOException,
AutomationException
ISettingsInRegistry
restoreForCurrentUser in interface ISettingsInRegistrybstrRegPath - The bstrRegPath (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void storeForCurrentUser(java.lang.String bstrRegPath)
throws java.io.IOException,
AutomationException
ISettingsInRegistry
storeForCurrentUser in interface ISettingsInRegistrybstrRegPath - The bstrRegPath (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
public void restoreDefault()
throws java.io.IOException,
AutomationException
ISettingsInRegistry
restoreDefault in interface ISettingsInRegistryjava.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws java.io.IOException,
AutomationException
ISupportErrorInfoIndicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||