com.esri.arcgis.display
Class BalloonCallout

java.lang.Object
  com.esri.arcgis.display.BalloonCallout

All Implemented Interfaces:

IBalloonCallout, ICallout, IDisplayName, IQueryGeometry, ITextBackground, ITextBackground2, ITextMargins, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class BalloonCallout
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBalloonCallout, ITextBackground, ITextBackground2, ITextMargins, IQueryGeometry, IPersistStream, IPersist, IClone, IDisplayName, IXMLSerialize, java.io.Externalizable

COM Class 'BalloonCallout'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'A filled background that is placed behind text.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.display.IBalloonCallout

IID, IIDc8d09ed0_4fbb_11d1_9a72_0080c7ec5c96, xxDummy

Fields inherited from interface com.esri.arcgis.display.ICallout

IID6a7ef980_6924_11d2_980d_0080c7e04196

Fields inherited from interface com.esri.arcgis.display.ITextBackground

IID, IID8feb6611_2a0d_11d1_9a44_0080c7ec5c96, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITextBackground2

IID, IID63fc25a7_438b_4f97_888e_105e6d461828, xxDummy

Fields inherited from interface com.esri.arcgis.display.ITextMargins

IID, IID6a7ef982_6924_11d2_980d_0080c7e04196, xxDummy

Fields inherited from interface com.esri.arcgis.display.IQueryGeometry

IID, IID8e1b88f1_0a46_11d4_8276_0080c79f0371, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayName

IID, IIDf47b9b56_7efe_4ee4_b7d4_445f93ff390e, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

BalloonCallout()
Constructs a BalloonCallout using ArcGIS Engine.

BalloonCallout(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BalloonCallout theBalloonCallout = (BalloonCallout) 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(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IPoint	getAnchorPoint() The anchor point.
double	getBottomMargin() Value for the bottom margin.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
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).
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
java.lang.String	getNameString() The display name of an object.
double	getRightMargin() Value for the right margin.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getStyle() The balloon callout style.
IFillSymbol	getSymbol() The fill symbol.
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) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
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(java.io.ObjectInput in)
void	release() Release a BalloonCallout.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAnchorPoint(IPoint point) The anchor point.
void	setBottomMargin(double bottomMargin) Value for the bottom margin.
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	setRightMargin(double rightMargin) Value for the right margin.
void	setStyle(int style) The balloon callout style.
void	setSymbolByRef(IFillSymbol fillSym) The fill symbol.
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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

BalloonCallout

public BalloonCallout()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a BalloonCallout using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

BalloonCallout

public BalloonCallout(java.lang.Object obj)
               throws java.io.IOException

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

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

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 BalloonCallout.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getStyle

public int getStyle()
             throws java.io.IOException,
                    AutomationException

The balloon callout style.

Specified by:

getStyle in interface IBalloonCallout

Returns:

A com.esri.arcgis.display.esriBalloonCalloutStyle constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStyle

public void setStyle(int style)
              throws java.io.IOException,
                     AutomationException

The balloon callout style.

Specified by:

setStyle in interface IBalloonCallout

Parameters:

style - A com.esri.arcgis.display.esriBalloonCalloutStyle constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public IFillSymbol getSymbol()
                      throws java.io.IOException,
                             AutomationException

The fill symbol.

Specified by:

getSymbol in interface IBalloonCallout

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(IFillSymbol fillSym)
                    throws java.io.IOException,
                           AutomationException

The fill symbol.

Specified by:

setSymbolByRef in interface IBalloonCallout

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnchorPoint

public IPoint getAnchorPoint()
                      throws java.io.IOException,
                             AutomationException

The anchor point.

Specified by:

getAnchorPoint in interface ICallout

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

public void setAnchorPoint(IPoint point)
                    throws java.io.IOException,
                           AutomationException

The anchor point.

Specified by:

setAnchorPoint in interface ICallout

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeaderTolerance

public double getLeaderTolerance()
                          throws java.io.IOException,
                                 AutomationException

The closest distance to the text the anchor point can be for the callout to draw.

Specified by:

getLeaderTolerance in interface ICallout

Returns:

The leaderTolerance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeaderTolerance

public void setLeaderTolerance(double leaderTolerance)
                        throws java.io.IOException,
                               AutomationException

The closest distance to the text the anchor point can be for the callout to draw.

Specified by:

setLeaderTolerance in interface ICallout

Parameters:

leaderTolerance - The leaderTolerance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException

The text symbol.

Specified by:

getTextSymbol in interface ITextBackground

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

public void setTextSymbolByRef(ITextSymbol textSym)
                        throws java.io.IOException,
                               AutomationException

The text symbol.

Specified by:

setTextSymbolByRef in interface ITextBackground

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextBoxByRef

public void setTextBoxByRef(IEnvelope rhs1)
                     throws java.io.IOException,
                            AutomationException

The text box.

Specified by:

setTextBoxByRef in interface ITextBackground

Parameters:

rhs1 - 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.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation transform,
                          IPolygon boundary)
                   throws java.io.IOException,
                          AutomationException

Queries for the boundary of the text background.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int hDC,
                 ITransformation transform)
          throws java.io.IOException,
                 AutomationException

Draws the text background.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextBoundaryByRef

public void setTextBoundaryByRef(IPolygon rhs1)
                          throws java.io.IOException,
                                 AutomationException

The text boundary.

Specified by:

setTextBoundaryByRef in interface ITextBackground2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.IPolygon (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeftMargin

public double getLeftMargin()
                     throws java.io.IOException,
                            AutomationException

Value for the left margin.

Specified by:

getLeftMargin in interface ITextMargins

Returns:

The leftMargin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeftMargin

public void setLeftMargin(double leftMargin)
                   throws java.io.IOException,
                          AutomationException

Value for the left margin.

Specified by:

setLeftMargin in interface ITextMargins

Parameters:

leftMargin - The leftMargin (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRightMargin

public double getRightMargin()
                      throws java.io.IOException,
                             AutomationException

Value for the right margin.

Specified by:

getRightMargin in interface ITextMargins

Returns:

The rightMargin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRightMargin

public void setRightMargin(double rightMargin)
                    throws java.io.IOException,
                           AutomationException

Value for the right margin.

Specified by:

setRightMargin in interface ITextMargins

Parameters:

rightMargin - The rightMargin (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopMargin

public double getTopMargin()
                    throws java.io.IOException,
                           AutomationException

Value for the top margin.

Specified by:

getTopMargin in interface ITextMargins

Returns:

The topMargin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTopMargin

public void setTopMargin(double topMargin)
                  throws java.io.IOException,
                         AutomationException

Value for the top margin.

Specified by:

setTopMargin in interface ITextMargins

Parameters:

topMargin - The topMargin (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBottomMargin

public double getBottomMargin()
                       throws java.io.IOException,
                              AutomationException

Value for the bottom margin.

Specified by:

getBottomMargin in interface ITextMargins

Returns:

The bottomMargin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBottomMargin

public void setBottomMargin(double bottomMargin)
                     throws java.io.IOException,
                            AutomationException

Value for the bottom margin.

Specified by:

setBottomMargin in interface ITextMargins

Parameters:

bottomMargin - The bottomMargin (in)

Throws:

java.io.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 java.io.IOException,
                       AutomationException

Sets the margins.

Specified by:

putMargins in interface ITextMargins

Parameters:

left - The left (in)

top - The top (in)

right - The right (in)

bottom - The bottom (in)

Throws:

java.io.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 java.io.IOException,
                         AutomationException

Returns the margins.

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:

java.io.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 java.io.IOException,
                             AutomationException

Gets the actual geometry of the boundary of the object (which may or may not be a polygon).

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:

java.io.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 java.io.IOException,
                          AutomationException

Queries the envelope of the boundary of the object.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

The display name of an object.

Specified by:

getNameString in interface IDisplayName

Returns:

The displayName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException