com.esri.arcgis.output
Class ExportBMP

java.lang.Object
  extended by com.esri.arcgis.output.ExportBMP
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IExport, IExportBMP, IExportImage, ISettingsInRegistry, IWorldFileSettings, IWorldFileSettings2, ISupportErrorInfo, java.io.Serializable

public class ExportBMP
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IExportImage, IExportBMP, IExport, IWorldFileSettings, IWorldFileSettings2, ISettingsInRegistry, ISupportErrorInfo

COM Class 'ExportBMP'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriOutput.olb'

Description 'Class used to export maps to BMP (Windows Bitmap) format.' 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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.output.IExportImage
IID, IID4bf7d12a_5c15_4671_a9e2_11fce89f0873, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.IExportBMP
IID, IID759be840_8eb9_45a0_b511_2a297096344b, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.IExport
IID, IID55c11165_0c2d_4e2d_afea_10b4186c4364, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.IWorldFileSettings
IID, IID27bf29ca_71a8_422a_a66d_ff875a9de13b, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.IWorldFileSettings2
IID, IID167806fc_6bcb_491e_9fb0_827baf2c3dec, xxDummy
 
Fields inherited from interface com.esri.arcgis.output.ISettingsInRegistry
IID, IIDbb518176_e7e3_420a_9787_ae6e3487eb68, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
ExportBMP()
          Constructs a ExportBMP using ArcGIS Engine.
ExportBMP(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExportBMP theExportBMP = (ExportBMP) obj;
 
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.
 IColor getBackgroundColor()
          The background color of the Image.
 int getBiLevelThreshold()
          The Threshold value for BiLevel images.
 int getBitmap()
          The Windows Bitmap handle.
static java.lang.String getClsid()
          getClsid.
 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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IEnvelope getMapExtent()
          The Map Extent.
 double getMapRotation()
          The Map rotation angle in degrees.
 java.lang.String getName()
          The Name of the Exporter.
 int getPalette()
          The Windows Bitmap color palette.
 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.
 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 isRLECompression()
          The Windows Bitmap compression scheme for 8 bits per pixel and 4 bits per pixel.
 void release()
          Release a ExportBMP.
 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 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 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 setRLECompression(boolean compression)
          The Windows Bitmap compression scheme for 8 bits per pixel and 4 bits per pixel.
 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(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

ExportBMP

public ExportBMP()
          throws java.io.IOException,
                 java.net.UnknownHostException
Constructs a ExportBMP using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ExportBMP

public ExportBMP(java.lang.Object obj)
          throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExportBMP theExportBMP = (ExportBMP) obj;

Construct a ExportBMP using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ExportBMP.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ExportBMP.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setImageType

public void setImageType(int pimageType)
                  throws java.io.IOException,
                         AutomationException
Export Image Type.

Specified by:
setImageType in interface IExportImage
Parameters:
pimageType - A com.esri.arcgis.output.esriExportImageType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImageType

public int getImageType()
                 throws java.io.IOException,
                        AutomationException
Export Image Type.

Specified by:
getImageType in interface IExportImage
Returns:
A com.esri.arcgis.output.esriExportImageType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor ppBackgroundColor)
                        throws java.io.IOException,
                               AutomationException
The background color of the Image.

Specified by:
setBackgroundColor in interface IExportImage
Parameters:
ppBackgroundColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException
The background color of the Image.

Specified by:
getBackgroundColor in interface IExportImage
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(int pWidth)
              throws java.io.IOException,
                     AutomationException
The width of the Image. If width is zero, screen width is used.

Specified by:
setWidth in interface IExportImage
Parameters:
pWidth - The pWidth (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws java.io.IOException,
                    AutomationException
The width of the Image. If width is zero, screen width is used.

Specified by:
getWidth in interface IExportImage
Returns:
The pWidth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(int pHeight)
               throws java.io.IOException,
                      AutomationException
The height of the Image. If height is zero, screen height is used.

Specified by:
setHeight in interface IExportImage
Parameters:
pHeight - The pHeight (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws java.io.IOException,
                     AutomationException
The height of the Image. If height is zero, screen height is used.

Specified by:
getHeight in interface IExportImage
Returns:
The pHeight
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBitmap

public int getBitmap()
              throws java.io.IOException,
                     AutomationException
The Windows Bitmap handle.

Specified by:
getBitmap in interface IExportBMP
Returns:
The phBmp (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPalette

public int getPalette()
               throws java.io.IOException,
                      AutomationException
The Windows Bitmap color palette.

Specified by:
getPalette in interface IExportBMP
Returns:
The phPal (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRLECompression

public void setRLECompression(boolean compression)
                       throws java.io.IOException,
                              AutomationException
The Windows Bitmap compression scheme for 8 bits per pixel and 4 bits per pixel.

Specified by:
setRLECompression in interface IExportBMP
Parameters:
compression - The compression (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRLECompression

public boolean isRLECompression()
                         throws java.io.IOException,
                                AutomationException
The Windows Bitmap compression scheme for 8 bits per pixel and 4 bits per pixel.

Specified by:
isRLECompression in interface IExportBMP
Returns:
The compression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBiLevelThreshold

public void setBiLevelThreshold(int threshold)
                         throws java.io.IOException,
                                AutomationException
The Threshold value for BiLevel images. The Threshold value will be used if esriExportImageType is equal to esriExportImageTypeBiLevelThreshold.

Specified by:
setBiLevelThreshold in interface IExportBMP
Parameters:
threshold - The threshold (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBiLevelThreshold

public int getBiLevelThreshold()
                        throws java.io.IOException,
                               AutomationException
The Threshold value for BiLevel images. The Threshold value will be used if esriExportImageType is equal to esriExportImageTypeBiLevelThreshold.

Specified by:
getBiLevelThreshold in interface IExportBMP
Returns:
The threshold
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The Name of the Exporter.

Specified by:
getName in interface IExport
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilter

public java.lang.String getFilter()
                           throws java.io.IOException,
                                  AutomationException
Filter String used in the CFileDialog class.

Specified by:
getFilter in interface IExport
Returns:
The filter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws java.io.IOException,
                       AutomationException
Exporter's priority - the order of appearance in the user interface.

Specified by:
getPriority in interface IExport
Returns:
The pPriority
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStepProgressorByRef

public void setStepProgressorByRef(IStepProgressor rhs1)
                            throws java.io.IOException,
                                   AutomationException
Export will update a Progress Bar if StepProgressor is not NULL.

Specified by:
setStepProgressorByRef in interface IExport
Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IStepProgressor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel rhs1)
                         throws java.io.IOException,
                                AutomationException
Export will react on Cancel if TrackCancel is not NULL.

Specified by:
setTrackCancelByRef in interface IExport
Parameters:
rhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelBounds

public void setPixelBounds(IEnvelope pixelBounds)
                    throws java.io.IOException,
                           AutomationException
The Export Bounds in Pixels (The Pixel Bounds of the Export surface).

Specified by:
setPixelBounds in interface IExport
Parameters:
pixelBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelBounds

public IEnvelope getPixelBounds()
                         throws java.io.IOException,
                                AutomationException
The Export Bounds in Pixels (The Pixel Bounds of the Export surface).

Specified by:
getPixelBounds in interface IExport
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExportFileName

public void setExportFileName(java.lang.String fileName)
                       throws java.io.IOException,
                              AutomationException
The Export File Name.

Specified by:
setExportFileName in interface IExport
Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExportFileName

public java.lang.String getExportFileName()
                                   throws java.io.IOException,
                                          AutomationException
The Export File Name.

Specified by:
getExportFileName in interface IExport
Returns:
The fileName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResolution

public void setResolution(double res)
                   throws java.io.IOException,
                          AutomationException
The Export Resolution.

Specified by:
setResolution in interface IExport
Parameters:
res - The res (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResolution

public double getResolution()
                     throws java.io.IOException,
                            AutomationException
The Export Resolution.

Specified by:
getResolution in interface IExport
Returns:
The res
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startExporting

public int startExporting()
                   throws java.io.IOException,
                          AutomationException
Initializes the Exporter.

Specified by:
startExporting in interface IExport
Returns:
The hDC (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

finishExporting

public void finishExporting()
                     throws java.io.IOException,
                            AutomationException
Shuts down the Exporter.

Specified by:
finishExporting in interface IExport
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cleanup

public void cleanup()
             throws java.io.IOException,
                    AutomationException
Cleanup should clean all temporary files, free used memory, etc...

Specified by:
cleanup in interface IExport
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapExtent

public void setMapExtent(IEnvelope mapExtent)
                  throws java.io.IOException,
                         AutomationException
The Map Extent.

Specified by:
setMapExtent in interface IWorldFileSettings
Parameters:
mapExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapExtent

public IEnvelope getMapExtent()
                       throws java.io.IOException,
                              AutomationException
The Map Extent.

Specified by:
getMapExtent in interface IWorldFileSettings
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputWorldFile

public void setOutputWorldFile(boolean outputWorldFile)
                        throws java.io.IOException,
                               AutomationException
Indicates if a World File will be created.

Specified by:
setOutputWorldFile in interface IWorldFileSettings
Parameters:
outputWorldFile - The outputWorldFile (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOutputWorldFile

public boolean isOutputWorldFile()
                          throws java.io.IOException,
                                 AutomationException
Indicates if a World File will be created.

Specified by:
isOutputWorldFile in interface IWorldFileSettings
Returns:
The outputWorldFile
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMapRotation

public void setMapRotation(double mapRotAngle)
                    throws java.io.IOException,
                           AutomationException
The Map rotation angle in degrees.

Specified by:
setMapRotation in interface IWorldFileSettings2
Parameters:
mapRotAngle - The mapRotAngle (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapRotation

public double getMapRotation()
                      throws java.io.IOException,
                             AutomationException
The Map rotation angle in degrees.

Specified by:
getMapRotation in interface IWorldFileSettings2
Returns:
The mapRotAngle
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restoreForCurrentUser

public void restoreForCurrentUser(java.lang.String bstrRegPath)
                           throws java.io.IOException,
                                  AutomationException
Restore object settings.

Specified by:
restoreForCurrentUser in interface ISettingsInRegistry
Parameters:
bstrRegPath - The bstrRegPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

storeForCurrentUser

public void storeForCurrentUser(java.lang.String bstrRegPath)
                         throws java.io.IOException,
                                AutomationException
Store object settings.

Specified by:
storeForCurrentUser in interface ISettingsInRegistry
Parameters:
bstrRegPath - The bstrRegPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restoreDefault

public void restoreDefault()
                    throws java.io.IOException,
                           AutomationException
Restore the default object settings.

Specified by:
restoreDefault in interface ISettingsInRegistry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.