com.esri.arcgis.carto
Class ExportInfoGenerator

java.lang.Object
  com.esri.arcgis.carto.ExportInfoGenerator

All Implemented Interfaces:

IExportInfoGenerator, IFeatureExportInfoGenerator, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ExportInfoGenerator
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IExportInfoGenerator, IFeatureExportInfoGenerator

Generates information for exporting into the display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

ExportInfoGenerator()
Constructs a ExportInfoGenerator using ArcGIS Engine.

ExportInfoGenerator(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExportInfoGenerator theExportInfoGenerator = (ExportInfoGenerator) obj;

Method Summary

void	addFeatureAttribute(IDisplay display, int fieldType, String fieldName, String fieldValue) Generates export information for a feature attribute.
void	beginFeature(IFeature feature, IDisplay display) Generates export information that a feature is starting to draw.
void	beginFeatureAttributes(IDisplay display) Generates export information to begin the exporting of feature attributes.
void	beginGroup(IDisplay pDisplay, String comment) Generates export information that a group is starting to draw.
void	beginLayer(IDisplay pDisplay, String comment) Generates export information that a layer is starting to draw.
void	beginLayerWithName(IDisplay pDisplay, ILayer pLayer) Generates export information that a layer is starting to draw.
void	beginLayerWithNameAndPhase(IDisplay pDisplay, ILayer pLayer, int viewDrawPhase) Generates export information that a layer is starting to draw.
void	beginMap(IDisplay pDisplay, int hDC, IMap pMap) Generates export information that a map is starting to draw.
void	beginPageLayout(int hDC, int focusMap) Generates export information that a page layout is starting to draw.
void	beginText(IDisplay pDisplay, int type, int kerning, double tracking, double widthScale, double wordSpace, double lineLeading, String text) Generates export information about text that is starting to draw.
void	endFeature(IDisplay display) Generates export information that a feature finished to draw.
void	endFeatureAttributes(IDisplay display) Generates export information to end the exportng of feature attributes.
void	endGroup(IDisplay pDisplay) Generates export information that a group finished to draw.
void	endLayer(IDisplay pDisplay) Generates export information that a layer finished to draw.
void	endMap(int hDC) Generates export information that a map finished to draw.
void	endPageLayout(int hDC) Generates export information that a page layout finished to draw.
void	endText(IDisplay pDisplay) Generates export information that a started text has ended.
boolean	equals(Object o) Compare this object with another
void	generateFeatureInfo(IFeature feature, IDisplay display) Generates export information (attributes) for a feature into the display.
void	generateHyperlinkInfo(IFeature feature, IDisplay display) Generates export information (hyperlinks, hotlinks) for a feature into the display.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	prepareExportFilter(IFeatureClass fc, IQueryFilter filter) Adds the exported fields to the filter.
void	setCmykColor(IDisplay pDisplay, int cmykColor, boolean spotColor, int colorType) Generates export information for a CMYK-color.
void	setHotlinkContainerByRef(IHotlinkContainer rhs1) The hotlink container.
void	setHyperlinkContainerByRef(IHyperlinkContainer rhs1) The hyperlink container.
void	setLayerFieldsByRef(ILayerFields rhs1) The layer fields.

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

ExportInfoGenerator

public ExportInfoGenerator()
                    throws IOException,
                           UnknownHostException

Constructs a ExportInfoGenerator using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ExportInfoGenerator

public ExportInfoGenerator(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ExportInfoGenerator theExportInfoGenerator = (ExportInfoGenerator) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

beginText

public void beginText(IDisplay pDisplay,
                      int type,
                      int kerning,
                      double tracking,
                      double widthScale,
                      double wordSpace,
                      double lineLeading,
                      String text)
               throws IOException,
                      AutomationException

Generates export information about text that is starting to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginText in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

type - The type (in)

kerning - The kerning (in)

tracking - The tracking (in)

widthScale - The widthScale (in)

wordSpace - The wordSpace (in)

lineLeading - The lineLeading (in)

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endText

public void endText(IDisplay pDisplay)
             throws IOException,
                    AutomationException

Generates export information that a started text has ended.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endText in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCmykColor

public void setCmykColor(IDisplay pDisplay,
                         int cmykColor,
                         boolean spotColor,
                         int colorType)
                  throws IOException,
                         AutomationException

Generates export information for a CMYK-color.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setCmykColor in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

cmykColor - The cmykColor (A COM typedef) (in)

spotColor - The spotColor (in)

colorType - The colorType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginLayer

public void beginLayer(IDisplay pDisplay,
                       String comment)
                throws IOException,
                       AutomationException

Generates export information that a layer is starting to draw. Adds the comment to the information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginLayer in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

comment - The comment (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginLayerWithName

public void beginLayerWithName(IDisplay pDisplay,
                               ILayer pLayer)
                        throws IOException,
                               AutomationException

Generates export information that a layer is starting to draw. Adds the layer name to the information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginLayerWithName in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginLayerWithNameAndPhase

public void beginLayerWithNameAndPhase(IDisplay pDisplay,
                                       ILayer pLayer,
                                       int viewDrawPhase)
                                throws IOException,
                                       AutomationException

Generates export information that a layer is starting to draw. Adds the layer name and draw phase to the information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginLayerWithNameAndPhase in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

viewDrawPhase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endLayer

public void endLayer(IDisplay pDisplay)
              throws IOException,
                     AutomationException

Generates export information that a layer finished to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endLayer in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginGroup

public void beginGroup(IDisplay pDisplay,
                       String comment)
                throws IOException,
                       AutomationException

Generates export information that a group is starting to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginGroup in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

comment - The comment (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endGroup

public void endGroup(IDisplay pDisplay)
              throws IOException,
                     AutomationException

Generates export information that a group finished to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endGroup in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginMap

public void beginMap(IDisplay pDisplay,
                     int hDC,
                     IMap pMap)
              throws IOException,
                     AutomationException

Generates export information that a map is starting to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginMap in interface IExportInfoGenerator

Parameters:

pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

hDC - The hDC (A COM typedef) (in)

pMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endMap

public void endMap(int hDC)
            throws IOException,
                   AutomationException

Generates export information that a map finished to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endMap in interface IExportInfoGenerator

Parameters:

hDC - The hDC (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginPageLayout

public void beginPageLayout(int hDC,
                            int focusMap)
                     throws IOException,
                            AutomationException

Generates export information that a page layout is starting to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginPageLayout in interface IExportInfoGenerator

Parameters:

hDC - The hDC (A COM typedef) (in)

focusMap - The focusMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endPageLayout

public void endPageLayout(int hDC)
                   throws IOException,
                          AutomationException

Generates export information that a page layout finished to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endPageLayout in interface IExportInfoGenerator

Parameters:

hDC - The hDC (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerFieldsByRef

public void setLayerFieldsByRef(ILayerFields rhs1)
                         throws IOException,
                                AutomationException

The layer fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLayerFieldsByRef in interface IFeatureExportInfoGenerator

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.ILayerFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHyperlinkContainerByRef

public void setHyperlinkContainerByRef(IHyperlinkContainer rhs1)
                                throws IOException,
                                       AutomationException

The hyperlink container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setHyperlinkContainerByRef in interface IFeatureExportInfoGenerator

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IHyperlinkContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHotlinkContainerByRef

public void setHotlinkContainerByRef(IHotlinkContainer rhs1)
                              throws IOException,
                                     AutomationException

The hotlink container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setHotlinkContainerByRef in interface IFeatureExportInfoGenerator

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IHotlinkContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

prepareExportFilter

public void prepareExportFilter(IFeatureClass fc,
                                IQueryFilter filter)
                         throws IOException,
                                AutomationException

Adds the exported fields to the filter. Needs layer fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

prepareExportFilter in interface IFeatureExportInfoGenerator

Parameters:

fc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

filter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateFeatureInfo

public void generateFeatureInfo(IFeature feature,
                                IDisplay display)
                         throws IOException,
                                AutomationException

Generates export information (attributes) for a feature into the display. Needs layer fields.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

generateFeatureInfo in interface IFeatureExportInfoGenerator

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateHyperlinkInfo

public void generateHyperlinkInfo(IFeature feature,
                                  IDisplay display)
                           throws IOException,
                                  AutomationException

Generates export information (hyperlinks, hotlinks) for a feature into the display.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

generateHyperlinkInfo in interface IFeatureExportInfoGenerator

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginFeature

public void beginFeature(IFeature feature,
                         IDisplay display)
                  throws IOException,
                         AutomationException

Generates export information that a feature is starting to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginFeature in interface IFeatureExportInfoGenerator

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endFeature

public void endFeature(IDisplay display)
                throws IOException,
                       AutomationException

Generates export information that a feature finished to draw.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endFeature in interface IFeatureExportInfoGenerator

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginFeatureAttributes

public void beginFeatureAttributes(IDisplay display)
                            throws IOException,
                                   AutomationException

Generates export information to begin the exporting of feature attributes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

beginFeatureAttributes in interface IFeatureExportInfoGenerator

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFeatureAttribute

public void addFeatureAttribute(IDisplay display,
                                int fieldType,
                                String fieldName,
                                String fieldValue)
                         throws IOException,
                                AutomationException

Generates export information for a feature attribute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

addFeatureAttribute in interface IFeatureExportInfoGenerator

Parameters:

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

fieldType - A com.esri.arcgis.geodatabase.esriFieldType constant (in)

fieldName - The fieldName (in)

fieldValue - The fieldValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endFeatureAttributes

public void endFeatureAttributes(IDisplay display)
                          throws IOException,
                                 AutomationException

Generates export information to end the exportng of feature attributes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

endFeatureAttributes in interface IFeatureExportInfoGenerator

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.