com.esri.arcgis.display
Class LineCallout

java.lang.Object
  extended by com.esri.arcgis.display.LineCallout
All Implemented Interfaces:
ICallout, IDisplayName, ILineCallout, IMarkerBackground, IQueryGeometry, ITextBackground, ITextBackground2, ITextMargins, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class LineCallout
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILineCallout, ITextBackground, ITextBackground2, IMarkerBackground, ITextMargins, IQueryGeometry, IPersistStream, IPersist, IClone, IDisplayName, IXMLSerialize, Externalizable

A series of line symbols that link text to a specified location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
LineCallout()
          Constructs a LineCallout using ArcGIS Engine.
LineCallout(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LineCallout theLineCallout = (LineCallout) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void draw(int hDC, ITransformation transform)
          Draws the text background.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 ILineSymbol getAccentBar()
          The line symbol used to render the accent bar.
 IPoint getAnchorPoint()
          The anchor point.
 IFillSymbol getBorder()
          The fill symbol used to render the border.
 double getBottomMargin()
          Value for the bottom margin.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 double getGap()
          The gap.
 IGeometry getGeometry(int hDC, ITransformation displayTransform, IGeometry drawGeometry)
          Gets the actual geometry of the boundary of the object (which may or may not be a polygon).
 ILineSymbol getLeaderLine()
          The line symbol used to render the leader line.
 double getLeaderTolerance()
          The closest distance to the text the anchor point can be for the callout to draw.
 double getLeftMargin()
          Value for the left margin.
 IMarkerSymbol getMarkerSymbol()
          The marker symbol.
 String getNameString()
          The display name of an object.
 double getRightMargin()
          Value for the right margin.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getStyle()
          The line callout style.
 ITextSymbol getTextSymbol()
          The text symbol.
 double getTopMargin()
          Value for the top margin.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void markerBackgroundDraw(int hDC, ITransformation transform)
          Draws the marker background.
 void markerBackgroundQueryBoundary(int hDC, ITransformation transform, IPolygon boundary)
          Queries the boundary of the marker background.
 void putMargins(double left, double top, double right, double bottom)
          Sets the margins.
 void queryBoundary(int hDC, ITransformation transform, IPolygon boundary)
          Queries for the boundary of the text background.
 void queryEnvelope(int hDC, ITransformation displayTransform, IGeometry drawGeometry, IEnvelope envelope)
          Queries the envelope of the boundary of the object.
 void queryMargins(double[] left, double[] top, double[] right, double[] bottom)
          Returns the margins.
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAccentBarByRef(ILineSymbol accentBar)
          The line symbol used to render the accent bar.
 void setAnchorPoint(IPoint point)
          The anchor point.
 void setBorderByRef(IFillSymbol border)
          The fill symbol used to render the border.
 void setBottomMargin(double bottomMargin)
          Value for the bottom margin.
 void setGap(double gap)
          The gap.
 void setLeaderLineByRef(ILineSymbol leaderLine)
          The line symbol used to render the leader line.
 void setLeaderTolerance(double leaderTolerance)
          The closest distance to the text the anchor point can be for the callout to draw.
 void setLeftMargin(double leftMargin)
          Value for the left margin.
 void setMarkerBoxByRef(IEnvelope rhs1)
          The marker box.
 void setMarkerSymbolByRef(IMarkerSymbol markerSym)
          The marker symbol.
 void setRightMargin(double rightMargin)
          Value for the right margin.
 void setStyle(int style)
          The line callout style.
 void setTextBoundaryByRef(IPolygon rhs1)
          The text boundary.
 void setTextBoxByRef(IEnvelope rhs1)
          The text box.
 void setTextSymbolByRef(ITextSymbol textSym)
          The text symbol.
 void setTopMargin(double topMargin)
          Value for the top margin.
 void writeExternal(ObjectOutput out)
           
 
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

LineCallout

public LineCallout()
            throws IOException,
                   UnknownHostException
Constructs a LineCallout using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

LineCallout

public LineCallout(Object obj)
            throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LineCallout theLineCallout = (LineCallout) obj;

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

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

getBorder

public IFillSymbol getBorder()
                      throws IOException,
                             AutomationException
The fill symbol used to render the border.

Description

Border is the fill symbol used as the background for the text. Any fill supported by the IFillSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBorder in interface ILineCallout
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBorderByRef

public void setBorderByRef(IFillSymbol border)
                    throws IOException,
                           AutomationException
The fill symbol used to render the border.

Description

Border is the fill symbol used as the background for the text. Any fill supported by the IFillSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBorderByRef in interface ILineCallout
Parameters:
border - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGap

public double getGap()
              throws IOException,
                     AutomationException
The gap.

Description

Gap is the distance between the Border and the AccentBar. The Gap is specified in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGap in interface ILineCallout
Returns:
The gap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGap

public void setGap(double gap)
            throws IOException,
                   AutomationException
The gap.

Description

Gap is the distance between the Border and the AccentBar. The Gap is specified in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGap in interface ILineCallout
Parameters:
gap - The gap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAccentBar

public ILineSymbol getAccentBar()
                         throws IOException,
                                AutomationException
The line symbol used to render the accent bar.

Description

AccentBar is a vertical line placed at either the right or left edge of the Border. Any line supported by the ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAccentBar in interface ILineCallout
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAccentBarByRef

public void setAccentBarByRef(ILineSymbol accentBar)
                       throws IOException,
                              AutomationException
The line symbol used to render the accent bar.

Description

AccentBar is a vertical line placed at either the right or left edge of the Border. Any line supported by the ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAccentBarByRef in interface ILineCallout
Parameters:
accentBar - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStyle

public int getStyle()
             throws IOException,
                    AutomationException
The line callout style.

Description

Style is the enumeration that controls the shape of the LeaderLine as well as the positioning of the AccentBar. The avaialble options include: esriLCSBase, esriLCSCircularCCW, esriLCSCircularCW, esriLCSCustom, esriLCSFourPoint, esriLCSMidpoint, esriLCSThreePoint and esriLCSUnderline. esriLCSMidpoint is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getStyle in interface ILineCallout
Returns:
A com.esri.arcgis.display.esriLineCalloutStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStyle

public void setStyle(int style)
              throws IOException,
                     AutomationException
The line callout style.

Description

Style is the enumeration that controls the shape of the LeaderLine as well as the positioning of the AccentBar. The avaialble options include: esriLCSBase, esriLCSCircularCCW, esriLCSCircularCW, esriLCSCustom, esriLCSFourPoint, esriLCSMidpoint, esriLCSThreePoint and esriLCSUnderline. esriLCSMidpoint is the default Style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setStyle in interface ILineCallout
Parameters:
style - A com.esri.arcgis.display.esriLineCalloutStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderLine

public ILineSymbol getLeaderLine()
                          throws IOException,
                                 AutomationException
The line symbol used to render the leader line.

Description

LeaderLine is the line that connects the text to the anchor point. Any line supported by the ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLeaderLine in interface ILineCallout
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderLineByRef

public void setLeaderLineByRef(ILineSymbol leaderLine)
                        throws IOException,
                               AutomationException
The line symbol used to render the leader line.

Description

LeaderLine is the line that connects the text to the anchor point. Any line supported by the ILineSymbol object can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLeaderLineByRef in interface ILineCallout
Parameters:
leaderLine - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnchorPoint

public IPoint getAnchorPoint()
                      throws IOException,
                             AutomationException
The anchor point.

Description

AnchorPoint is the location from which the leader will be drawn to the callout. This is typically the X,Y coordinates of the feature being labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnchorPoint in interface ICallout
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

public void setAnchorPoint(IPoint point)
                    throws IOException,
                           AutomationException
The anchor point.

Description

AnchorPoint is the location from which the leader will be drawn to the callout. This is typically the X,Y coordinates of the feature being labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAnchorPoint in interface ICallout
Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeaderTolerance

public double getLeaderTolerance()
                          throws IOException,
                                 AutomationException
The closest distance to the text the anchor point can be for the callout to draw.

Description

LeaderTolerance is the minimum distance the callout must be from the anchor before a leader is drawn. This distance is specified in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLeaderTolerance in interface ICallout
Returns:
The leaderTolerance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeaderTolerance

public void setLeaderTolerance(double leaderTolerance)
                        throws IOException,
                               AutomationException
The closest distance to the text the anchor point can be for the callout to draw.

Description

LeaderTolerance is the minimum distance the callout must be from the anchor before a leader is drawn. This distance is specified in points (approx. 1/72 of an inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLeaderTolerance in interface ICallout
Parameters:
leaderTolerance - The leaderTolerance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException
The text symbol.

Description

The TextSymbol of which the Background is a property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTextSymbol in interface ITextBackground
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol textSym)
                        throws IOException,
                               AutomationException
The text symbol.

Description

The TextSymbol of which the Background is a property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTextSymbolByRef in interface ITextBackground
Parameters:
textSym - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextBoxByRef

public void setTextBoxByRef(IEnvelope rhs1)
                     throws IOException,
                            AutomationException
The text box.

Description

The TextBox property is write-only. It is set by a TextSymbol before a call to ITextBackground::Draw or ITextBackground::QueryBoundary. For this reason, the ITextBackground also has a TextSymbol property, which is the TextSymbol of which the Background is a property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation transform,
                          IPolygon boundary)
                   throws IOException,
                          AutomationException
Queries for the boundary of the text background.

Description

Use the QueryBoundary method to find the shape of a callout. This method populates a Polygon with the boundary of the callout. For a LineCallout, this is the minimum bounding rectangle of the leader line and text background box. For a BalloonCallout, this is the shape of the balloon. For a MarkerTextBackground, this is the union of the bounding box of the Marker and the Text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryBoundary in interface ITextBackground
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int hDC,
                 ITransformation transform)
          throws IOException,
                 AutomationException
Draws the text background.

Description

The Draw method is used in a similar way to the ISymbol::Draw method. Note that ISymbol::Draw called on a TextSymbol coclass will also call ITextBackground::Draw, if a Background is set, thus drawing both the background and the text. Note that there is no Geometry required in this method; the location and size of the TextBackground is determined by the TextSymbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ITextBackground
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextBoundaryByRef

public void setTextBoundaryByRef(IPolygon rhs1)
                          throws IOException,
                                 AutomationException
The text boundary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTextBoundaryByRef in interface ITextBackground2
Parameters:
rhs1 - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkerSymbol

public IMarkerSymbol getMarkerSymbol()
                              throws IOException,
                                     AutomationException
The marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMarkerSymbol in interface IMarkerBackground
Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkerSymbolByRef

public void setMarkerSymbolByRef(IMarkerSymbol markerSym)
                          throws IOException,
                                 AutomationException
The marker symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMarkerSymbolByRef in interface IMarkerBackground
Parameters:
markerSym - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkerBoxByRef

public void setMarkerBoxByRef(IEnvelope rhs1)
                       throws IOException,
                              AutomationException
The marker box.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

markerBackgroundQueryBoundary

public void markerBackgroundQueryBoundary(int hDC,
                                          ITransformation transform,
                                          IPolygon boundary)
                                   throws IOException,
                                          AutomationException
Queries the boundary of the marker background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
markerBackgroundQueryBoundary in interface IMarkerBackground
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

markerBackgroundDraw

public void markerBackgroundDraw(int hDC,
                                 ITransformation transform)
                          throws IOException,
                                 AutomationException
Draws the marker background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
markerBackgroundDraw in interface IMarkerBackground
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeftMargin

public double getLeftMargin()
                     throws IOException,
                            AutomationException
Value for the left margin.

Description

LeftMargin specifies the distance between the text and the left edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLeftMargin in interface ITextMargins
Returns:
The leftMargin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLeftMargin

public void setLeftMargin(double leftMargin)
                   throws IOException,
                          AutomationException
Value for the left margin.

Description

LeftMargin specifies the distance between the text and the left edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLeftMargin in interface ITextMargins
Parameters:
leftMargin - The leftMargin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRightMargin

public double getRightMargin()
                      throws IOException,
                             AutomationException
Value for the right margin.

Description

RightMargin specifies the distance between the text and the right edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRightMargin in interface ITextMargins
Returns:
The rightMargin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRightMargin

public void setRightMargin(double rightMargin)
                    throws IOException,
                           AutomationException
Value for the right margin.

Description

RightMargin specifies the distance between the text and the right edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRightMargin in interface ITextMargins
Parameters:
rightMargin - The rightMargin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTopMargin

public double getTopMargin()
                    throws IOException,
                           AutomationException
Value for the top margin.

Description

TopMargin specifies the distance between the text and the top edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getTopMargin in interface ITextMargins
Returns:
The topMargin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTopMargin

public void setTopMargin(double topMargin)
                  throws IOException,
                         AutomationException
Value for the top margin.

Description

TopMargin specifies the distance between the text and the top edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setTopMargin in interface ITextMargins
Parameters:
topMargin - The topMargin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBottomMargin

public double getBottomMargin()
                       throws IOException,
                              AutomationException
Value for the bottom margin.

Description

BottomMargin specifies the distance between the text and the bottom edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBottomMargin in interface ITextMargins
Returns:
The bottomMargin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBottomMargin

public void setBottomMargin(double bottomMargin)
                     throws IOException,
                            AutomationException
Value for the bottom margin.

Description

BottomMargin specifies the distance between the text and the bottom edge of the callout.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBottomMargin in interface ITextMargins
Parameters:
bottomMargin - The bottomMargin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putMargins

public void putMargins(double left,
                       double top,
                       double right,
                       double bottom)
                throws IOException,
                       AutomationException
Sets the margins.

Description

PutMargins enables setting the value for all four margins, left, top, right and bottom simultaneously.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
putMargins in interface ITextMargins
Parameters:
left - The left (in)
top - The top (in)
right - The right (in)
bottom - The bottom (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryMargins

public void queryMargins(double[] left,
                         double[] top,
                         double[] right,
                         double[] bottom)
                  throws IOException,
                         AutomationException
Returns the margins.

Description

QueryMargins returns the value for all four margins, left, top, right and bottom.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryMargins in interface ITextMargins
Parameters:
left - The left (out: use single element array)
top - The top (out: use single element array)
right - The right (out: use single element array)
bottom - The bottom (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry(int hDC,
                             ITransformation displayTransform,
                             IGeometry drawGeometry)
                      throws IOException,
                             AutomationException
Gets the actual geometry of the boundary of the object (which may or may not be a polygon).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGeometry in interface IQueryGeometry
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
drawGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryEnvelope

public void queryEnvelope(int hDC,
                          ITransformation displayTransform,
                          IGeometry drawGeometry,
                          IEnvelope envelope)
                   throws IOException,
                          AutomationException
Queries the envelope of the boundary of the object.

Description

You must instantiate the Envelope before calling QueryEnvelope. For example,

Dim pEnv as IEnvelope

Set pEnv = New Envelope

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryEnvelope in interface IQueryGeometry
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
drawGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException
The display name of an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNameString in interface IDisplayName
Returns:
The displayName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException