com.esri.arcgis.carto
Class MapServerLegendPatch

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

All Implemented Interfaces:

IMapServerLegendPatch, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class MapServerLegendPatch
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMapServerLegendPatch, IXMLSerialize, IPersistStream, IPersist, Externalizable

The Map Server Legend Patch coclass contains settings about a legend patch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

MapServerLegendPatch()
Constructs a MapServerLegendPatch using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IAreaPatch	getAreaPatch() The area patch.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ILinePatch	getLinePatch() The line patch.
double	getPatchHeight() The patch height (in points).
double	getPatchResolution() The patch resolution (dots per inch).
double	getPatchWidth() The patch width (in points).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAreaPatch(IAreaPatch patch) The area patch.
void	setLinePatch(ILinePatch patch) The line patch.
void	setPatchHeight(double heightPts) The patch height (in points).
void	setPatchResolution(double dpi) The patch resolution (dots per inch).
void	setPatchWidth(double widthPts) The patch width (in points).
void	writeExternal(ObjectOutput out)

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

MapServerLegendPatch

public MapServerLegendPatch()
                     throws IOException,
                            UnknownHostException

Constructs a MapServerLegendPatch using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

MapServerLegendPatch

public MapServerLegendPatch(Object obj)
                     throws IOException

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

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

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

getPatchWidth

public double getPatchWidth()
                     throws IOException,
                            AutomationException

The patch width (in points).

Remarks

Changing the size of the legend patch will not change the size of the symbol. It only changes the size of the patch surrounding the symbol. The size of the symbol is determined by the properties of the symbol itself. The symbol will increase in size if AreaPatch or LinePatch are used. A size should be specified. Entering 0 may lead to unexpected results.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPatchWidth in interface IMapServerLegendPatch

Returns:

The widthPts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchWidth

public void setPatchWidth(double widthPts)
                   throws IOException,
                          AutomationException

The patch width (in points).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPatchWidth in interface IMapServerLegendPatch

Parameters:

widthPts - The widthPts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchHeight

public double getPatchHeight()
                      throws IOException,
                             AutomationException

The patch height (in points).

Remarks

Changing the size of the legend patch will not change the size of the symbol. It only changes the size of the patch surrounding the symbol. The size of the symbol is determined by the properties of the symbol itself. The symbol will increase in size if AreaPatch or LinePatch are used. A size should be specified. Entering 0 may lead to unexpected results.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPatchHeight in interface IMapServerLegendPatch

Returns:

The heightPts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchHeight

public void setPatchHeight(double heightPts)
                    throws IOException,
                           AutomationException

The patch height (in points).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPatchHeight in interface IMapServerLegendPatch

Parameters:

heightPts - The heightPts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchResolution

public double getPatchResolution()
                          throws IOException,
                                 AutomationException

The patch resolution (dots per inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPatchResolution in interface IMapServerLegendPatch

Returns:

The dpi

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchResolution

public void setPatchResolution(double dpi)
                        throws IOException,
                               AutomationException

The patch resolution (dots per inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPatchResolution in interface IMapServerLegendPatch

Parameters:

dpi - The dpi (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinePatch

public ILinePatch getLinePatch()
                        throws IOException,
                               AutomationException

The line patch.

Remarks

Assign a custom line shape to the symbol such as a zigzag line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLinePatch in interface IMapServerLegendPatch

Returns:

A reference to a com.esri.arcgis.carto.ILinePatch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinePatch

public void setLinePatch(ILinePatch patch)
                  throws IOException,
                         AutomationException

The line patch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLinePatch in interface IMapServerLegendPatch

Parameters:

patch - A reference to a com.esri.arcgis.carto.ILinePatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaPatch

public IAreaPatch getAreaPatch()
                        throws IOException,
                               AutomationException

The area patch.

Remarks

Assign a custom shape to the symbol such as a triangle or rounded polygon.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAreaPatch in interface IMapServerLegendPatch

Returns:

A reference to a com.esri.arcgis.carto.IAreaPatch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaPatch

public void setAreaPatch(IAreaPatch patch)
                  throws IOException,
                         AutomationException

The area patch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAreaPatch in interface IMapServerLegendPatch

Parameters:

patch - A reference to a com.esri.arcgis.carto.IAreaPatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException