com.esri.arcgis.carto
Interface IACShieldSymbol

All Superinterfaces:

Serializable

All Known Implementing Classes:

ACShieldSymbol

public interface IACShieldSymbol
extends Serializable

Provides access to members that control ArcIMS shield symbol.

Product Availability

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

Method Summary

String	getFont() The font name.
IColor	getFontColor() The font color.
int	getFontSize() The font size.
int	getFontStyle() The font style.
int	getLabelMode() The label mode.
int	getMinSize() The shield size.
IColor	getShadowColor() The shadow color.
int	getType() The shield type.
boolean	isShadow() Indicates if the shadow is used.
void	setFont(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	setLabelMode(int labelMode) The label mode.
void	setMinSize(int size) The shield size.
void	setShadow(boolean flag) Indicates if the shadow is used.
void	setShadowColor(IColor color) The shadow color.
void	setType(int type) The shield type.

Method Detail

getFont

String getFont()
               throws IOException,
                      AutomationException

The font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The font

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFont

void setFont(String font)
             throws IOException,
                    AutomationException

The font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

font - The font (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontStyle

int getFontStyle()
                 throws IOException,
                        AutomationException

The font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.acFontStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontStyle

void setFontStyle(int fontStyle)
                  throws IOException,
                         AutomationException

The font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontSize

int getFontSize()
                throws IOException,
                       AutomationException

The font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fontSize

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontSize

void setFontSize(int fontSize)
                 throws IOException,
                        AutomationException

The font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fontSize - The fontSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFontColor

IColor getFontColor()
                    throws IOException,
                           AutomationException

The font color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFontColor

void setFontColor(IColor color)
                  throws IOException,
                         AutomationException

The font color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShadow

boolean isShadow()
                 throws IOException,
                        AutomationException

Indicates if the shadow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadow

void setShadow(boolean flag)
               throws IOException,
                      AutomationException

Indicates if the shadow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShadowColor

IColor getShadowColor()
                      throws IOException,
                             AutomationException

The shadow color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadowColor

void setShadowColor(IColor color)
                    throws IOException,
                           AutomationException

The shadow color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelMode

int getLabelMode()
                 throws IOException,
                        AutomationException

The label mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.acLabelMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelMode

void setLabelMode(int labelMode)
                  throws IOException,
                         AutomationException

The label mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

labelMode - A com.esri.arcgis.carto.acLabelMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinSize

int getMinSize()
               throws IOException,
                      AutomationException

The shield size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinSize

void setMinSize(int size)
                throws IOException,
                       AutomationException

The shield size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException

The shield type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.acShieldSymbolType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

void setType(int type)
             throws IOException,
                    AutomationException

The shield type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

type - A com.esri.arcgis.carto.acShieldSymbolType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.