com.esri.arcgis.carto
Interface IPatch

All Superinterfaces:

Serializable

All Known Implementing Classes:

AreaPatch, LinePatch

public interface IPatch
extends Serializable

Provides access to members that work with a legend patch.

Remarks

IPatch is the generic interfaces used to modify the aspect of the patches, the small lines or rectangles used to display legend classes and the text that goes with them.

Since the patches can be areas or lines two separate interfaces exist: IAreaPatch and ILinePatch, the associated objects contain geometries of different types but no specific properties or methods.

Product Availability

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

Method Summary

IGeometry	get_Geometry(IEnvelope bounds) Patch geometry sized to fit the specified bounds.
String	getName() Name of the patch.
boolean	isPreserveAspectRatio() Indicates if aspect ratio of patch is preserved.
void	setGeometry(IGeometry rhs1) Patch geometry.
void	setName(String name) Name of the patch.
void	setPreserveAspectRatio(boolean flag) Indicates if aspect ratio of patch is preserved.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the patch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the patch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPreserveAspectRatio

boolean isPreserveAspectRatio()
                              throws IOException,
                                     AutomationException

Indicates if aspect ratio of patch is preserved.

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.

setPreserveAspectRatio

void setPreserveAspectRatio(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates if aspect ratio of patch is preserved.

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.

setGeometry

void setGeometry(IGeometry rhs1)
                 throws IOException,
                        AutomationException

Patch geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

get_Geometry

IGeometry get_Geometry(IEnvelope bounds)
                       throws IOException,
                              AutomationException

Patch geometry sized to fit the specified bounds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (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.