com.esri.arcgis.display
Class SymbologyEnvironment

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

All Implemented Interfaces:

IFontsInSymbolsEnvironment, IPictureSymbolEnvironment, ISymbologyEnvironment, ISymbologyEnvironment2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SymbologyEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISymbologyEnvironment, ISymbologyEnvironment2, IPictureSymbolEnvironment, IFontsInSymbolsEnvironment

Controls how symbols are drawn as Graphical Device Interface (GDI) objects.

Description

The SymbologyEnvironment coclass is a Singleton and controls certain details of how symbols are drawn as Graphical Device Interface (GDI) objects. Most developers will find it unnecessary to change the default SymbologyEnvironment properties, as the coclass is used primarily by ArcMap to set symbology options for exporting and printing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

SymbologyEnvironment()
Constructs a SymbologyEnvironment using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getPictureSymbolOptions() Output options for layers with picture symbols.
int	hashCode() the hashcode for this object
boolean	isDisableFontAntialiasing() Disabling fonts antialiasing in symbols.
boolean	isGeometryClipping() Indicates if all geometry is clipped on output.
boolean	isOutputGDICommentForCMYKColor() Indicates if a GDI comment is output for CMYK colors.
boolean	isOutputGDICommentForFeatureAttributes() Indicates if a GDI comment is output for feature attributes.
boolean	isOutputGDICommentForGroupings() Indicates if a GDI comment is output for groupings.
boolean	isOutputGDICommentForHyperlinks() Indicates if a GDI comment is output for hyperlinks.
boolean	isOutputGDICommentForLayers() Indicates if a GDI comment is output for layers.
boolean	isOutputGDICommentForMapsAndLayout() Indicates if a GDI comment is output for Maps and Page Layout.
boolean	isOutputGDICommentForText() Indicates if a GDI comment is output for text.
boolean	isStrokeTrueTypeMarkers() Indicates if TrueType markers are stroked.
void	setDisableFontAntialiasing(boolean bDisable) Disabling fonts antialiasing in symbols.
void	setGeometryClipping(boolean geometryClipping) Indicates if all geometry is clipped on output.
void	setOutputGDICommentForCMYKColor(boolean pCmykColor) Indicates if a GDI comment is output for CMYK colors.
void	setOutputGDICommentForFeatureAttributes(boolean featureAttributes) Indicates if a GDI comment is output for feature attributes.
void	setOutputGDICommentForGroupings(boolean grouping) Indicates if a GDI comment is output for groupings.
void	setOutputGDICommentForHyperlinks(boolean hyperlinks) Indicates if a GDI comment is output for hyperlinks.
void	setOutputGDICommentForLayers(boolean layers) Indicates if a GDI comment is output for layers.
void	setOutputGDICommentForMapsAndLayout(boolean maps) Indicates if a GDI comment is output for Maps and Page Layout.
void	setOutputGDICommentForText(boolean text) Indicates if a GDI comment is output for text.
void	setPictureSymbolOptions(int options) Output options for layers with picture symbols.
void	setStrokeTrueTypeMarkers(boolean strokeTrueTypeMarkers) Indicates if TrueType markers are stroked.

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

SymbologyEnvironment

public SymbologyEnvironment()
                     throws IOException,
                            UnknownHostException

Constructs a SymbologyEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SymbologyEnvironment

public SymbologyEnvironment(Object obj)
                     throws IOException

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

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

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

isOutputGDICommentForCMYKColor

public boolean isOutputGDICommentForCMYKColor()
                                       throws IOException,
                                              AutomationException

Indicates if a GDI comment is output for CMYK colors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOutputGDICommentForCMYKColor in interface ISymbologyEnvironment

Returns:

The pCmykColor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForCMYKColor

public void setOutputGDICommentForCMYKColor(boolean pCmykColor)
                                     throws IOException,
                                            AutomationException

Indicates if a GDI comment is output for CMYK colors.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutputGDICommentForCMYKColor in interface ISymbologyEnvironment

Parameters:

pCmykColor - The pCmykColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForLayers

public boolean isOutputGDICommentForLayers()
                                    throws IOException,
                                           AutomationException

Indicates if a GDI comment is output for layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOutputGDICommentForLayers in interface ISymbologyEnvironment

Returns:

The layers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForLayers

public void setOutputGDICommentForLayers(boolean layers)
                                  throws IOException,
                                         AutomationException

Indicates if a GDI comment is output for layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutputGDICommentForLayers in interface ISymbologyEnvironment

Parameters:

layers - The layers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForGroupings

public boolean isOutputGDICommentForGroupings()
                                       throws IOException,
                                              AutomationException

Indicates if a GDI comment is output for groupings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOutputGDICommentForGroupings in interface ISymbologyEnvironment

Returns:

The grouping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForGroupings

public void setOutputGDICommentForGroupings(boolean grouping)
                                     throws IOException,
                                            AutomationException

Indicates if a GDI comment is output for groupings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutputGDICommentForGroupings in interface ISymbologyEnvironment

Parameters:

grouping - The grouping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForText

public boolean isOutputGDICommentForText()
                                  throws IOException,
                                         AutomationException

Indicates if a GDI comment is output for text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isOutputGDICommentForText in interface ISymbologyEnvironment

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForText

public void setOutputGDICommentForText(boolean text)
                                throws IOException,
                                       AutomationException

Indicates if a GDI comment is output for text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutputGDICommentForText in interface ISymbologyEnvironment

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGeometryClipping

public boolean isGeometryClipping()
                           throws IOException,
                                  AutomationException

Indicates if all geometry is clipped on output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isGeometryClipping in interface ISymbologyEnvironment

Returns:

The geometryClipping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryClipping

public void setGeometryClipping(boolean geometryClipping)
                         throws IOException,
                                AutomationException

Indicates if all geometry is clipped on output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGeometryClipping in interface ISymbologyEnvironment

Parameters:

geometryClipping - The geometryClipping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStrokeTrueTypeMarkers

public boolean isStrokeTrueTypeMarkers()
                                throws IOException,
                                       AutomationException

Indicates if TrueType markers are stroked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isStrokeTrueTypeMarkers in interface ISymbologyEnvironment

Returns:

The strokeTrueTypeMarkers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStrokeTrueTypeMarkers

public void setStrokeTrueTypeMarkers(boolean strokeTrueTypeMarkers)
                              throws IOException,
                                     AutomationException

Indicates if TrueType markers are stroked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStrokeTrueTypeMarkers in interface ISymbologyEnvironment

Parameters:

strokeTrueTypeMarkers - The strokeTrueTypeMarkers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForFeatureAttributes

public boolean isOutputGDICommentForFeatureAttributes()
                                               throws IOException,
                                                      AutomationException

Indicates if a GDI comment is output for feature attributes.

Product Availability

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

Specified by:

isOutputGDICommentForFeatureAttributes in interface ISymbologyEnvironment2

Returns:

The featureAttributes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForFeatureAttributes

public void setOutputGDICommentForFeatureAttributes(boolean featureAttributes)
                                             throws IOException,
                                                    AutomationException

Indicates if a GDI comment is output for feature attributes.

Product Availability

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

Specified by:

setOutputGDICommentForFeatureAttributes in interface ISymbologyEnvironment2

Parameters:

featureAttributes - The featureAttributes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForHyperlinks

public boolean isOutputGDICommentForHyperlinks()
                                        throws IOException,
                                               AutomationException

Indicates if a GDI comment is output for hyperlinks.

Product Availability

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

Specified by:

isOutputGDICommentForHyperlinks in interface ISymbologyEnvironment2

Returns:

The hyperlinks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForHyperlinks

public void setOutputGDICommentForHyperlinks(boolean hyperlinks)
                                      throws IOException,
                                             AutomationException

Indicates if a GDI comment is output for hyperlinks.

Product Availability

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

Specified by:

setOutputGDICommentForHyperlinks in interface ISymbologyEnvironment2

Parameters:

hyperlinks - The hyperlinks (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOutputGDICommentForMapsAndLayout

public boolean isOutputGDICommentForMapsAndLayout()
                                           throws IOException,
                                                  AutomationException

Indicates if a GDI comment is output for Maps and Page Layout.

Product Availability

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

Specified by:

isOutputGDICommentForMapsAndLayout in interface ISymbologyEnvironment2

Returns:

The maps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputGDICommentForMapsAndLayout

public void setOutputGDICommentForMapsAndLayout(boolean maps)
                                         throws IOException,
                                                AutomationException

Indicates if a GDI comment is output for Maps and Page Layout.

Product Availability

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

Specified by:

setOutputGDICommentForMapsAndLayout in interface ISymbologyEnvironment2

Parameters:

maps - The maps (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPictureSymbolOptions

public int getPictureSymbolOptions()
                            throws IOException,
                                   AutomationException

Output options for layers with picture symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPictureSymbolOptions in interface IPictureSymbolEnvironment

Returns:

A com.esri.arcgis.display.esriPictureSymbolOptions constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPictureSymbolOptions

public void setPictureSymbolOptions(int options)
                             throws IOException,
                                    AutomationException

Output options for layers with picture symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPictureSymbolOptions in interface IPictureSymbolEnvironment

Parameters:

options - A com.esri.arcgis.display.esriPictureSymbolOptions constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisableFontAntialiasing

public boolean isDisableFontAntialiasing()
                                  throws IOException,
                                         AutomationException

Disabling fonts antialiasing in symbols.

Product Availability

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

Specified by:

isDisableFontAntialiasing in interface IFontsInSymbolsEnvironment

Returns:

The bDisable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisableFontAntialiasing

public void setDisableFontAntialiasing(boolean bDisable)
                                throws IOException,
                                       AutomationException

Disabling fonts antialiasing in symbols.

Product Availability

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

Specified by:

setDisableFontAntialiasing in interface IFontsInSymbolsEnvironment

Parameters:

bDisable - The bDisable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.