com.esri.arcgis.carto
Class ACTextSymbol

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

All Implemented Interfaces:

IACAxl, IACSymbol, IACTextSymbol, IClone, IPersist, IPersistStream, java.io.Serializable

public class ACTextSymbol

extends java.lang.Object

implements IACAxl, IACSymbol, IACTextSymbol, IPersist, IPersistStream, IClone

ArcIMS Text Symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

ACTextSymbol()
Constructs a ACTextSymbol using ArcGIS Engine.

ACTextSymbol(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IACAxl	getAsIACAxl() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACSymbol	getAsIACSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACTextSymbol	getAsIACTextSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IColor	getBlockoutColor() The background color.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.Object	getElement() The element that represents the XML.
java.lang.String	getFont() The font name.
IColor	getFontColor() The font color.
int	getFontSize() The font size.
int	getFontStyle() The font style.
IColor	getGlowingColor() The glowing color.
int	getInterval() The interval.
IColor	getOutlineColor() The outline color.
int	getPrintMode() The print mode.
IColor	getShadowColor() The shadow color.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
double	getTransparency() The transparency in percent (0-100).
int	hashCode() the hashcode for this object
boolean	isAntialiasing() Indicates if the antialias is ON or OFF.
boolean	isBlockout() Indicates if the background is used.
void	isDirty() Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isGlowing() Indicates if the glow is used.
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
boolean	isOutline() Indicates if the outline is used.
boolean	isShadow() Indicates if the shadow is used.
void	load(IStream pstm) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setAntialiasing(boolean flag) Indicates if the antialias is ON or OFF.
void	setBlockout(boolean flag) Indicates if the background is used.
void	setBlockoutColor(IColor color) The background color.
void	setElementByRef(java.lang.Object element) The element that represents the XML.
void	setFont(java.lang.String font) The font name.
void	setFontColor(IColor color) The font color.
void	setFontSize(int fontSize) The font size.
void	setFontStyle(int fontStyle) The font style.
void	setGlowing(boolean flag) Indicates if the glow is used.
void	setGlowingColor(IColor color) The glowing color.
void	setInterval(int interval) The interval.
void	setOutline(boolean flag) Indicates if the outline is used.
void	setOutlineColor(IColor color) The outline color.
void	setPrintMode(int printMode) The print mode.
void	setShadow(boolean flag) Indicates if the shadow is used.
void	setShadowColor(IColor color) The shadow color.
void	setTransparency(double trans) The transparency in percent (0-100).

Methods inherited from class java.lang.Object

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

Constructor Detail

ACTextSymbol

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

Constructs a ACTextSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACTextSymbol

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a ACTextSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ACTextSymbol.
ACTextSymbol theACTextSymbol = (ACTextSymbol) obj;

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()

getAsIACAxl

public IACAxl getAsIACAxl()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACSymbol

public IACSymbol getAsIACSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIACTextSymbol

public IACTextSymbol getAsIACTextSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getElement

public java.lang.Object getElement()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IACAxl

The element that represents the XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getElement in interface IACAxl

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElementByRef

public void setElementByRef(java.lang.Object element)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACAxl

The element that represents the XML.

Specified by:

setElementByRef in interface IACAxl

Parameters:

element - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparency

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

Description copied from interface: IACSymbol

The transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTransparency in interface IACSymbol

Returns:

The trans

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setTransparency

public void setTransparency(double trans)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACSymbol

The transparency in percent (0-100).

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTransparency in interface IACSymbol

Parameters:

trans - The trans (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isAntialiasing

public boolean isAntialiasing()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IACSymbol

Indicates if the antialias is ON or OFF.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAntialiasing in interface IACSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAntialiasing

public void setAntialiasing(boolean flag)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACSymbol

Indicates if the antialias is ON or OFF.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAntialiasing in interface IACSymbol

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFont

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

Description copied from interface: IACTextSymbol

The font name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFont in interface IACTextSymbol

Returns:

The font

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFont

public void setFont(java.lang.String font)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IACTextSymbol

The font name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFont in interface IACTextSymbol

Parameters:

font - The font (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFontStyle

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

Description copied from interface: IACTextSymbol

The font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontStyle in interface IACTextSymbol

Returns:

A com.esri.arcgis.carto.acFontStyle constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFontStyle

public void setFontStyle(int fontStyle)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACTextSymbol

The font style.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontStyle in interface IACTextSymbol

Parameters:

fontStyle - A com.esri.arcgis.carto.acFontStyle constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFontSize

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

Description copied from interface: IACTextSymbol

The font size.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontSize in interface IACTextSymbol

Returns:

The fontSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFontSize

public void setFontSize(int fontSize)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACTextSymbol

The font size.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontSize in interface IACTextSymbol

Parameters:

fontSize - The fontSize (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFontColor

public IColor getFontColor()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACTextSymbol

The font color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFontColor in interface IACTextSymbol

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFontColor

public void setFontColor(IColor color)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACTextSymbol

The font color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFontColor in interface IACTextSymbol

Parameters:

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

isOutline

public boolean isOutline()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACTextSymbol

Indicates if the outline is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOutline in interface IACTextSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutline

public void setOutline(boolean flag)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IACTextSymbol

Indicates if the outline is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutline in interface IACTextSymbol

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutlineColor

public IColor getOutlineColor()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IACTextSymbol

The outline color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOutlineColor in interface IACTextSymbol

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setOutlineColor

public void setOutlineColor(IColor color)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACTextSymbol

The outline color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutlineColor in interface IACTextSymbol

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isGlowing

public boolean isGlowing()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACTextSymbol

Indicates if the glow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isGlowing in interface IACTextSymbol

Returns:

The flag

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setGlowing

public void setGlowing(boolean flag)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IACTextSymbol

Indicates if the glow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGlowing in interface IACTextSymbol

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getGlowingColor

public IColor getGlowingColor()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IACTextSymbol

The glowing color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGlowingColor in interface IACTextSymbol

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setGlowingColor

public void setGlowingColor(IColor color)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACTextSymbol

The glowing color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGlowingColor in interface IACTextSymbol

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isShadow

public boolean isShadow()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACTextSymbol

Indicates if the shadow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShadow in interface IACTextSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShadow

public void setShadow(boolean flag)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IACTextSymbol

Indicates if the shadow is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadow in interface IACTextSymbol

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShadowColor

public IColor getShadowColor()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IACTextSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShadowColor in interface IACTextSymbol

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.

setShadowColor

public void setShadowColor(IColor color)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACTextSymbol

The shadow color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShadowColor in interface IACTextSymbol

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isBlockout

public boolean isBlockout()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IACTextSymbol

Indicates if the background is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBlockout in interface IACTextSymbol

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBlockout

public void setBlockout(boolean flag)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACTextSymbol

Indicates if the background is used.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBlockout in interface IACTextSymbol

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBlockoutColor

public IColor getBlockoutColor()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IACTextSymbol

The background color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBlockoutColor in interface IACTextSymbol

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.

setBlockoutColor

public void setBlockoutColor(IColor color)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IACTextSymbol

The background color.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBlockoutColor in interface IACTextSymbol

Parameters:

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

getInterval

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

Description copied from interface: IACTextSymbol

The interval.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInterval in interface IACTextSymbol

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInterval

public void setInterval(int interval)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACTextSymbol

The interval.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInterval in interface IACTextSymbol

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrintMode

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

Description copied from interface: IACTextSymbol

The print mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPrintMode in interface IACTextSymbol

Returns:

A com.esri.arcgis.carto.acPrintMode constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPrintMode

public void setPrintMode(int printMode)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACTextSymbol

The print mode.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPrintMode in interface IACTextSymbol

Parameters:

printMode - A com.esri.arcgis.carto.acPrintMode constant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_clone

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

Description copied from interface: IClone

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

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

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

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

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

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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