com.esri.arcgis.display
Class PictureMarkerSymbol

java.lang.Object
  extended bycom.esri.arcgis.display.PictureMarkerSymbol
All Implemented Interfaces:
ICartographicMarkerSymbol, IClone, IDisplayName, IMapLevel, IMarkerMask, IMarkerSymbol, IPersist, IPersistStream, IPictureMarkerSymbol, IPropertySupport, ISymbol, ISymbolRotation, IXMLSerialize, java.io.Serializable

public class PictureMarkerSymbol
extends java.lang.Object
implements IPictureMarkerSymbol, IMapLevel, ISymbol, ICartographicMarkerSymbol, ISymbolRotation, IMarkerMask, IPropertySupport, IPersistStream, IPersist, IClone, IDisplayName, IXMLSerialize

A marker symbol based on either a BMP or an EMF picture.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

Use PictureMarkerSymbol to create a marker symbol that is based on the contents of a Windows Bitmap (.bmp), or Enhanced Metafile (.emf) file.

See Also:
Serialized Form

Constructor Summary
PictureMarkerSymbol()
          Constructs a PictureMarkerSymbol using ArcGIS Engine.
PictureMarkerSymbol(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 boolean applies(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at any given time.
 java.lang.Object apply(java.lang.Object newObject)
          Applies the given property to the receiver and returns the old object.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean canApply(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at that particular moment.
 void createMarkerSymbolFromFile(int type, java.lang.String fileName)
          Create symbol from picture file.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void draw(IGeometry geometry)
          Draws the specified shape.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 double getAngle()
          Marker symbol angle.
 ICartographicMarkerSymbol getAsICartographicMarkerSymbol()
          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.
 IDisplayName getAsIDisplayName()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMapLevel getAsIMapLevel()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IMarkerMask getAsIMarkerMask()
          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.
 IPictureMarkerSymbol getAsIPictureMarkerSymbol()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IPropertySupport getAsIPropertySupport()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISymbol getAsISymbol()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISymbolRotation getAsISymbolRotation()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IXMLSerialize getAsIXMLSerialize()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IColor getBackgroundColor()
          Background color of the picture for 1 bit images.
 IColor getBitmapTransparencyColor()
          Color within bitmap indicating transparency.
 void getClassID(GUID[] pClassID)
          Supported Platforms
static java.lang.String getClsid()
           
 IColor getColor()
          Marker symbol color.
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 int getMapLevel()
          Current map level for drawing multi-level symbols.
 java.lang.String getNameString()
          The display name of an object.
 Picture getPicture()
          Picture used for marker symbol.
 int getROP2()
          Raster operation code for pixel drawing.
 double getSize()
          Marker symbol size.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          Supported Platforms
 double getXOffset()
          Symbol X-axis offset from point location.
 double getXScale()
          Symbol scale along X-axis.
 double getYOffset()
          Symbol Y-axis offset from point location.
 double getYScale()
          Symbol scale along Y-axis.
 int hashCode()
          the hashcode for this object
 void isDirty()
          Supported Platforms
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isRotateWithTransform()
          Indicates if the symbol rotates with the display.
 boolean isSwapForeGroundBackGroundColor()
          Indicates if foreground and background colors are swapped on 1 Bit Images Only.
 void load(IStream pstm)
          Supported Platforms
 void queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary)
          Fills an existing polygon with the boundary of the specified symbol.
 void queryMarkerMask(int hDC, ITransformation transform, IGeometry geometry, IPolygon boundary)
          Returns the mask geometry for the marker.
 void resetDC()
          Restores DC to original state.
 void save(IStream pstm, int fClearDirty)
          Supported Platforms
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAngle(double angle)
          Marker symbol angle.
 void setBackgroundColor(IColor color)
          Background color of the picture for 1 bit images.
 void setBitmapTransparencyColor(IColor color)
          Color within bitmap indicating transparency.
 void setColor(IColor color)
          Marker symbol color.
 void setMapLevel(int mapLevel)
          Current map level for drawing multi-level symbols.
 void setPictureByRef(Picture pictureDisp)
          Picture used for marker symbol.
 void setROP2(int drawMode)
          Raster operation code for pixel drawing.
 void setRotateWithTransform(boolean flag)
          Indicates if the symbol rotates with the display.
 void setSize(double size)
          Marker symbol size.
 void setSwapForeGroundBackGroundColor(boolean swap)
          Indicates if foreground and background colors are swapped on 1 Bit Images Only.
 void setupDC(int hDC, ITransformation transformation)
          Prepares the DC for drawing the symbol.
 void setXOffset(double xOffset)
          Symbol X-axis offset from point location.
 void setXScale(double xScale)
          Symbol scale along X-axis.
 void setYOffset(double yOffset)
          Symbol Y-axis offset from point location.
 void setYScale(double yScale)
          Symbol scale along Y-axis.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PictureMarkerSymbol

public PictureMarkerSymbol()
                    throws java.io.IOException,
                           java.net.UnknownHostException
Constructs a PictureMarkerSymbol using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

PictureMarkerSymbol

public PictureMarkerSymbol(java.lang.Object obj)
                    throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a PictureMarkerSymbol using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to PictureMarkerSymbol.
PictureMarkerSymbol thePictureMarkerSymbol = (PictureMarkerSymbol) 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()

getAsIPictureMarkerSymbol

public IPictureMarkerSymbol getAsIPictureMarkerSymbol()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMapLevel

public IMapLevel getAsIMapLevel()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISymbol

public ISymbol getAsISymbol()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsICartographicMarkerSymbol

public ICartographicMarkerSymbol getAsICartographicMarkerSymbol()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISymbolRotation

public ISymbolRotation getAsISymbolRotation()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIMarkerMask

public IMarkerMask getAsIMarkerMask()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIPropertySupport

public IPropertySupport getAsIPropertySupport()
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.


getAsIPersist

public IPersist getAsIPersist()
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.


getAsIDisplayName

public IDisplayName getAsIDisplayName()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIXMLSerialize

public IXMLSerialize getAsIXMLSerialize()
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


getPicture

public Picture getPicture()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IPictureMarkerSymbol
Picture used for marker symbol.

Supported Platforms

Windows, Solaris, Linux

Description

Specifies the bitmap image used for the marker. Use the IPictureDisp interface to specify the image.

Remarks

Only bitmap images may be specified. Use the CreateFillSymbolFromFile method to access emf files.

Specified by:
getPicture in interface IPictureMarkerSymbol
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPictureByRef

public void setPictureByRef(Picture pictureDisp)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IPictureMarkerSymbol
Picture used for marker symbol.

Specified by:
setPictureByRef in interface IPictureMarkerSymbol
Parameters:
pictureDisp - A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IPictureMarkerSymbol
Background color of the picture for 1 bit images.

Supported Platforms

Windows, Solaris, Linux

Description

Controls the Background color of the bitmap image or emf file. Any IColor supporting object may be used.

Specified by:
getBackgroundColor in interface IPictureMarkerSymbol
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.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IPictureMarkerSymbol
Background color of the picture for 1 bit images.

Supported Platforms

Windows, Solaris, Linux

Description

Controls the Background color of the bitmap image or emf file. Any IColor supporting object may be used.

Specified by:
setBackgroundColor in interface IPictureMarkerSymbol
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.

getBitmapTransparencyColor

public IColor getBitmapTransparencyColor()
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IPictureMarkerSymbol
Color within bitmap indicating transparency.

Supported Platforms

Windows, Solaris, Linux

Description

Changes the specified color within the bitmap to be transparent. BitmapTransparencyColor can be specified as any IColor object.

Remarks

BitmapTransparencyColor is only supported by color bitmap files. Emf files and 1-bit bitmap images are excluded.

Specified by:
getBitmapTransparencyColor in interface IPictureMarkerSymbol
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.

setBitmapTransparencyColor

public void setBitmapTransparencyColor(IColor color)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IPictureMarkerSymbol
Color within bitmap indicating transparency.

Supported Platforms

Windows, Solaris, Linux

Description

Changes the specified color within the bitmap to be transparent. BitmapTransparencyColor can be specified as any IColor object.

Remarks

BitmapTransparencyColor is only supported by color bitmap files. Emf files and 1-bit bitmap images are excluded.

Specified by:
setBitmapTransparencyColor in interface IPictureMarkerSymbol
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.

isSwapForeGroundBackGroundColor

public boolean isSwapForeGroundBackGroundColor()
                                        throws java.io.IOException,
                                               AutomationException
Description copied from interface: IPictureMarkerSymbol
Indicates if foreground and background colors are swapped on 1 Bit Images Only.

Supported Platforms

Windows, Solaris, Linux

Description

Boolean indicator to switch the foreground color with the background color of a 1-bit bitmap image.

Remarks

SwapForeGroundBackGroundColor is only supported by 1-bit bitmap files. Emf files and color bitmap images are excluded.

Specified by:
isSwapForeGroundBackGroundColor in interface IPictureMarkerSymbol
Returns:
The swap
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSwapForeGroundBackGroundColor

public void setSwapForeGroundBackGroundColor(boolean swap)
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: IPictureMarkerSymbol
Indicates if foreground and background colors are swapped on 1 Bit Images Only.

Supported Platforms

Windows, Solaris, Linux

Description

Boolean indicator to switch the foreground color with the background color of a 1-bit bitmap image.

Remarks

SwapForeGroundBackGroundColor is only supported by 1-bit bitmap files. Emf files and color bitmap images are excluded.

Specified by:
setSwapForeGroundBackGroundColor in interface IPictureMarkerSymbol
Parameters:
swap - The swap (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

createMarkerSymbolFromFile

public void createMarkerSymbolFromFile(int type,
                                       java.lang.String fileName)
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IPictureMarkerSymbol
Create symbol from picture file.

Supported Platforms

Windows, Solaris, Linux

Description

Loads the specified bitmap image or emf file. Use the esriPictureType enumerator to specify the type of picture being loaded. Supported types are esriIPictureBitmap (bitmap images) and esriIPictureEMF (emf files).

Remarks

Bitmap images are limited to a maxiumum of 256 colors.

Specified by:
createMarkerSymbolFromFile in interface IPictureMarkerSymbol
Parameters:
type - A com.esri.arcgis.display.esriIPictureType constant (in)
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSize

public double getSize()
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Specified by:
getSize in interface IMarkerSymbol
Returns:
The size
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSize

public void setSize(double size)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol size.

Supported Platforms

Windows, Solaris, Linux

Description

Size is the size (the largest measurement, height or width) in points (approx 1/72 inch) of a marker symbol.

Specified by:
setSize in interface IMarkerSymbol
Parameters:
size - The size (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getColor

public IColor getColor()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.
Color is not supported by the BarChartSymbol coclass. 

Specified by:
getColor in interface IMarkerSymbol
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.

setColor

public void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol color.

Supported Platforms

Windows, Solaris, Linux

Description

Color is the color of a marker symbol. Any of the Arc Map color interfaces may be used to create the color object.
Color is not supported by the BarChartSymbol coclass.

Specified by:
setColor in interface IMarkerSymbol
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.

getAngle

public double getAngle()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).
Angle is not supported by the BarChartSymbol coclass.

Specified by:
getAngle in interface IMarkerSymbol
Returns:
The angle
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setAngle

public void setAngle(double angle)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IMarkerSymbol
Marker symbol angle.

Supported Platforms

Windows, Solaris, Linux

Description

Angle is the number of degrees (0-360) that marker symbol is rotated. Rotation direction is counterclockwise and Arc Map assumes that directionality of the marker is horizontal (pointing in the positive X direction of a cartesian plane).
Angle is not supported by the BarChartSymbol coclass.

Specified by:
setAngle in interface IMarkerSymbol
Parameters:
angle - The angle (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getXOffset

public double getXOffset()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IMarkerSymbol
Symbol X-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
getXOffset in interface IMarkerSymbol
Returns:
The xOffset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXOffset

public void setXOffset(double xOffset)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMarkerSymbol
Symbol X-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

XOffset is the horizontal offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
setXOffset in interface IMarkerSymbol
Parameters:
xOffset - The xOffset (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getYOffset

public double getYOffset()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IMarkerSymbol
Symbol Y-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
getYOffset in interface IMarkerSymbol
Returns:
The yOffset
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setYOffset

public void setYOffset(double yOffset)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMarkerSymbol
Symbol Y-axis offset from point location.

Supported Platforms

Windows, Solaris, Linux

Description

YOffset is the vertical offset of the marker symbol in points (approx. 1/72 inch). Offsets may be positive or negative numbers.

Specified by:
setYOffset in interface IMarkerSymbol
Parameters:
yOffset - The yOffset (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getMapLevel

public int getMapLevel()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IMapLevel
Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMapLevel in interface IMapLevel
Returns:
The mapLevel
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setMapLevel

public void setMapLevel(int mapLevel)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IMapLevel
Current map level for drawing multi-level symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMapLevel in interface IMapLevel
Parameters:
mapLevel - The mapLevel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setupDC

public void setupDC(int hDC,
                    ITransformation transformation)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: ISymbol
Prepares the DC for drawing the symbol.

Specified by:
setupDC in interface ISymbol
Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetDC

public void resetDC()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: ISymbol
Restores DC to original state.

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetDC in interface ISymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IGeometry geometry)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: ISymbol
Draws the specified shape.

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface ISymbol
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBoundary

public void queryBoundary(int hDC,
                          ITransformation displayTransform,
                          IGeometry geometry,
                          IPolygon boundary)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: ISymbol
Fills an existing polygon with the boundary of the specified symbol.

Supported Platforms

Windows, Solaris, Linux

Remarks

Valid input Geometries are as follows:

For MarkerSymbols, the Geometry must be an IPoint.

For Fill Symbols, the Geometry can be either an IPolygon or an IEnvelope.

For Line Symbols, the Geometry must be an IPolyline.

Specified by:
queryBoundary in interface ISymbol
Parameters:
hDC - The hDC (A COM typedef) (in)
displayTransform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getROP2

public int getROP2()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: ISymbol
Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getROP2 in interface ISymbol
Returns:
A com.esri.arcgis.display.esriRasterOpCode constant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setROP2

public void setROP2(int drawMode)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: ISymbol
Raster operation code for pixel drawing.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setROP2 in interface ISymbol
Parameters:
drawMode - A com.esri.arcgis.display.esriRasterOpCode constant (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getXScale

public double getXScale()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ICartographicMarkerSymbol
Symbol scale along X-axis.

Supported Platforms

Windows, Solaris, Linux

Description

Scales the width of the Marker.

Specified by:
getXScale in interface ICartographicMarkerSymbol
Returns:
The xScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXScale

public void setXScale(double xScale)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ICartographicMarkerSymbol
Symbol scale along X-axis.

Supported Platforms

Windows, Solaris, Linux

Description

Scales the width of the Marker.

Specified by:
setXScale in interface ICartographicMarkerSymbol
Parameters:
xScale - The xScale (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getYScale

public double getYScale()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: ICartographicMarkerSymbol
Symbol scale along Y-axis.

Supported Platforms

Windows, Solaris, Linux

Description

Scales the height of the Marker.

Specified by:
getYScale in interface ICartographicMarkerSymbol
Returns:
The yScale
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setYScale

public void setYScale(double yScale)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: ICartographicMarkerSymbol
Symbol scale along Y-axis.

Supported Platforms

Windows, Solaris, Linux

Description

Scales the height of the Marker.

Specified by:
setYScale in interface ICartographicMarkerSymbol
Parameters:
yScale - The yScale (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isRotateWithTransform

public boolean isRotateWithTransform()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: ISymbolRotation
Indicates if the symbol rotates with the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isRotateWithTransform in interface ISymbolRotation
Returns:
The flag
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setRotateWithTransform

public void setRotateWithTransform(boolean flag)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ISymbolRotation
Indicates if the symbol rotates with the display.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRotateWithTransform in interface ISymbolRotation
Parameters:
flag - The flag (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

queryMarkerMask

public void queryMarkerMask(int hDC,
                            ITransformation transform,
                            IGeometry geometry,
                            IPolygon boundary)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IMarkerMask
Returns the mask geometry for the marker.

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryMarkerMask in interface IMarkerMask
Parameters:
hDC - The hDC (A COM typedef) (in)
transform - A reference to a com.esri.arcgis.geometry.ITransformation (in)
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPropertySupport
Indicates if the receiver can apply the given object at any given time.

Supported Platforms

Windows, Solaris, Linux

Remarks

Applies indicates whether the specified object can be applied to the current object.  For instance, we might want to ask our CircleElement whether a Color object applies to it.  If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time.  Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:
applies in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The applies
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IPropertySupport
Indicates if the receiver can apply the given object at that particular moment.

Supported Platforms

Windows, Solaris, Linux

Remarks

CanApply indicates whether the specified object can be applied to the current object.  For instance, we might want to ask our CircleElement whether a Color object applies to it.  If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time.  Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Specified by:
canApply in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
The canApply
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IPropertySupport
The object currently being used.

Supported Platforms

Windows, Solaris, Linux

Remarks

Current will return you the current object of the specified type.  For instance, I may ask a CircleElement if it supports a Color object.  If it does, then I can use Current to get the Color object currently applied to my CircleElement.

Specified by:
getCurrent in interface IPropertySupport
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IPropertySupport
Applies the given property to the receiver and returns the old object.

Supported Platforms

Windows, Solaris, Linux

Remarks

Apply will apply the specified object to the current object.  For instance, I might apply a Color object to my RectangleElement.  When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Specified by:
apply in interface IPropertySupport
Parameters:
newObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to another Object (IUnknown)
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.

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.

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.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IDisplayName
The display name of an object.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNameString in interface IDisplayName
Returns:
The displayName
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IXMLSerialize
Serializes an object to XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IXMLSerialize
Deserializes an object from XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.