|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.output.ExportJPEG
public class ExportJPEG
Class used to export maps to JPEG (Joint Photographic Experts Group) format.
Use the ExportJPEG CoClass to export your map to JPEG (Joint Photographic Experts Group) format. JPEG files are compressed image files. They support 24-bit color and are a good choice for use on the Web, because they provide control over output quality and size and can be more compact than many other file types.
The JPEG format uses "lossy" compression, meaning many pixel values will be discarded upon compression. Repeated editing and saving of a file stored with lossy compression can greatly degrade legibility of the stored image. When exporting maps to a format with lossy compression, be certain that small elements (map labels, point symbols, etc.) remain legible at the selected resolution and compression level.
Constructor Summary | |
---|---|
ExportJPEG()
Constructs a ExportJPEG using ArcGIS Engine. |
|
ExportJPEG(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ExportJPEG theExportJPEG = (ExportJPEG) 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. |
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. |
short |
getQuality()
The JPEG compression / image quality. |
double |
getResolution()
The Export Resolution. |
int |
getWidth()
The width of the Image. |
int |
hashCode()
the hashcode for this object |
void |
interfaceSupportsErrorInfo(GUID riid)
interfaceSupportsErrorInfo |
boolean |
isOutputWorldFile()
Indicates if a World File will be created. |
boolean |
isProgressiveMode()
The progressive JPEG export mode. |
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 |
setExportFileName(String fileName)
The Export File Name. |
void |
setHeight(int pHeight)
The height of the Image. |
void |
setImageType(int pimageType)
Export Image Type. |
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 |
setProgressiveMode(boolean bprogressive)
The progressive JPEG export mode. |
void |
setQuality(short quality)
The JPEG compression / image quality. |
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 |
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 ExportJPEG() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic ExportJPEG(Object obj) throws IOException
ExportJPEG theExportJPEG = (ExportJPEG) obj;
obj
to ExportJPEG
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public void setImageType(int pimageType) throws IOException, AutomationException
setImageType
in interface IExportImage
pimageType
- 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 IExportImage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setBackgroundColor(IColor ppBackgroundColor) throws IOException, AutomationException
setBackgroundColor
in interface IExportImage
ppBackgroundColor
- 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 IExportImage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setWidth(int pWidth) throws IOException, AutomationException
setWidth
in interface IExportImage
pWidth
- 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 IExportImage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setHeight(int pHeight) throws IOException, AutomationException
setHeight
in interface IExportImage
pHeight
- 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 IExportImage
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setQuality(short quality) throws IOException, AutomationException
setQuality
in interface IExportJPEG
quality
- The quality (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public short getQuality() throws IOException, AutomationException
getQuality
in interface IExportJPEG
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setProgressiveMode(boolean bprogressive) throws IOException, AutomationException
setProgressiveMode
in interface IExportJPEG
bprogressive
- The bprogressive (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isProgressiveMode() throws IOException, AutomationException
isProgressiveMode
in interface IExportJPEG
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
getName
in interface IExport
IOException
- 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 IExport
IOException
- 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 IExport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStepProgressorByRef(IStepProgressor rhs1) throws IOException, AutomationException
setStepProgressorByRef
in interface IExport
rhs1
- 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 IExport
rhs1
- 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 IExport
pixelBounds
- 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 IExport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExportFileName(String fileName) throws IOException, AutomationException
setExportFileName
in interface IExport
fileName
- 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 IExport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setResolution(double res) throws IOException, AutomationException
setResolution
in interface IExport
res
- 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 IExport
IOException
- 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 IExport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void finishExporting() throws IOException, AutomationException
finishExporting
in interface IExport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void cleanup() throws IOException, AutomationException
cleanup
in interface IExport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapExtent(IEnvelope mapExtent) throws IOException, AutomationException
setMapExtent
in interface IWorldFileSettings
mapExtent
- 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 IWorldFileSettings
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOutputWorldFile(boolean outputWorldFile) throws IOException, AutomationException
setOutputWorldFile
in interface IWorldFileSettings
outputWorldFile
- 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 IWorldFileSettings
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMapRotation(double mapRotAngle) throws IOException, AutomationException
setMapRotation
in interface IWorldFileSettings2
mapRotAngle
- 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 IWorldFileSettings2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void restoreForCurrentUser(String bstrRegPath) throws IOException, AutomationException
restoreForCurrentUser
in interface ISettingsInRegistry
bstrRegPath
- 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 ISettingsInRegistry
bstrRegPath
- 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 ISettingsInRegistry
IOException
- 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 ISupportErrorInfo
riid
- 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 |