com.esri.arcgis.display
Class BarChartSymbol

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

All Implemented Interfaces:

I3DChartSymbol, IBarChartSymbol, IChartSymbol, IClone, IMarkerBackgroundSupport, IMarkerSymbol, IPersist, IPersistStream, ISymbol, ISymbolArray, java.io.Serializable

public class BarChartSymbol

extends java.lang.Object

implements ISymbolArray, IChartSymbol, IBarChartSymbol, I3DChartSymbol, IMarkerSymbol, ISymbol, IPersistStream, IPersist, IClone, IMarkerBackgroundSupport

Defines a bar chart symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

This object is a symbol that is used by a ChartRenderer to draw bar or column charts for a feature layer.

See Also:

Serialized Form

Constructor Summary

BarChartSymbol()
Constructs a BarChartSymbol using ArcGIS Engine.

BarChartSymbol(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	addSymbol(ISymbol symbol) Adds a symbol to the array.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	clearSymbols() Removes all symbols from the array.
void	deleteSymbol(ISymbol symbol) Delete the given symbol.
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.
I3DChartSymbol	getAsI3DChartSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IBarChartSymbol	getAsIBarChartSymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IChartSymbol	getAsIChartSymbol() 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.
IMarkerBackgroundSupport	getAsIMarkerBackgroundSupport() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMarkerSymbol	getAsIMarkerSymbol() 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.
ISymbol	getAsISymbol() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISymbolArray	getAsISymbolArray() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILineSymbol	getAxes() The axis symbol.
IMarkerBackground	getBackground() The marker background.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IColor	getColor() Marker symbol color.
double	getMaxValue() The maximum value.
int	getROP2() Raster operation code for pixel drawing.
double	getSize() Marker symbol size.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
double	getSpacing() The spacing between bars in points.
ISymbol	getSymbol(int index) The symbol at the index position.
int	getSymbolCount() The number of symbols.
double	getThickness() 3D thickness of the chart symbol.
int	getTilt() Tilt of 3D Display (0-90 degrees).
double	getValue(int index) The value at the index position.
double	getWidth() The width of each bar in points.
double	getXOffset() Symbol X-axis offset from point location.
double	getYOffset() Symbol Y-axis offset from point location.
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
boolean	isDisplay3D() Indicates if the chart symbol is 3D.
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	isShowAxes() Indicates if the axis are shown.
boolean	isVerticalBars() Indicates if the bars are oriented vertically.
void	load(IStream pstm) Supported Platforms
void	moveSymbol(ISymbol symbol, int toIndex) Moves the given symbol to new index position.
void	queryBoundary(int hDC, ITransformation displayTransform, IGeometry geometry, IPolygon boundary) Fills an existing polygon with the boundary of the specified symbol.
void	resetDC() Restores DC to original state.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setAngle(double angle) Marker symbol angle.
void	setAxes(ILineSymbol symbol) The axis symbol.
void	setBackgroundByRef(IMarkerBackground background) The marker background.
void	setColor(IColor color) Marker symbol color.
void	setDisplay3D(boolean flag) Indicates if the chart symbol is 3D.
void	setMaxValue(double value) The maximum value.
void	setROP2(int drawMode) Raster operation code for pixel drawing.
void	setShowAxes(boolean flag) Indicates if the axis are shown.
void	setSize(double size) Marker symbol size.
void	setSpacing(double points) The spacing between bars in points.
void	setSymbolByRef(int index, ISymbol symbol) The symbol at the index position.
void	setThickness(double points) 3D thickness of the chart symbol.
void	setTilt(int angle) Tilt of 3D Display (0-90 degrees).
void	setupDC(int hDC, ITransformation transformation) Prepares the DC for drawing the symbol.
void	setValue(int index, double value) The value at the index position.
void	setVerticalBars(boolean flag) Indicates if the bars are oriented vertically.
void	setWidth(double points) The width of each bar in points.
void	setXOffset(double xOffset) Symbol X-axis offset from point location.
void	setYOffset(double yOffset) Symbol Y-axis offset from point location.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BarChartSymbol

public BarChartSymbol()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a BarChartSymbol using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

BarChartSymbol

public BarChartSymbol(java.lang.Object obj)
               throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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

getAsISymbolArray

public ISymbolArray getAsISymbolArray()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIChartSymbol

public IChartSymbol getAsIChartSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIBarChartSymbol

public IBarChartSymbol getAsIBarChartSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsI3DChartSymbol

public I3DChartSymbol getAsI3DChartSymbol()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMarkerSymbol

public IMarkerSymbol getAsIMarkerSymbol()

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.

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.

getAsIMarkerBackgroundSupport

public IMarkerBackgroundSupport getAsIMarkerBackgroundSupport()

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

getSymbolCount

public int getSymbolCount()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: ISymbolArray

The number of symbols.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbolCount in interface ISymbolArray

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getSymbol

public ISymbol getSymbol(int index)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolArray

The symbol at the index position.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbol in interface ISymbolArray

Parameters:

index - The index (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setSymbolByRef

public void setSymbolByRef(int index,
                           ISymbol symbol)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: ISymbolArray

The symbol at the index position.

Specified by:

setSymbolByRef in interface ISymbolArray

Parameters:

index - The index (in)

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

addSymbol

public void addSymbol(ISymbol symbol)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ISymbolArray

Adds a symbol to the array.

Supported Platforms

Windows, Solaris, Linux

Specified by:

addSymbol in interface ISymbolArray

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

deleteSymbol

public void deleteSymbol(ISymbol symbol)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolArray

Delete the given symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteSymbol in interface ISymbolArray

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

moveSymbol

public void moveSymbol(ISymbol symbol,
                       int toIndex)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ISymbolArray

Moves the given symbol to new index position.

Supported Platforms

Windows, Solaris, Linux

Specified by:

moveSymbol in interface ISymbolArray

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

toIndex - The toIndex (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearSymbols

public void clearSymbols()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: ISymbolArray

Removes all symbols from the array.

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearSymbols in interface ISymbolArray

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getValue

public double getValue(int index)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IChartSymbol

The value at the index position.

Supported Platforms

Windows, Solaris, Linux

Remarks

Value is used by ChartRenderer when drawing chart symbols for features. The number of values = the number of renderer fields = the number of chart components (e.g. pie slices, bar/columns, stacked chart slices). As chart symbols are created dynamically and drawn by the renderer, Value is the connection to the data values to determine how large the pie slices are for example for a given pie chart for a given feature.

Specified by:

getValue in interface IChartSymbol

Parameters:

index - The index (in)

Returns:

The value

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setValue

public void setValue(int index,
                     double value)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IChartSymbol

The value at the index position.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setValue in interface IChartSymbol

Parameters:

index - The index (in)

value - The value (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getMaxValue

public double getMaxValue()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IChartSymbol

The maximum value.

Supported Platforms

Windows, Solaris, Linux

Remarks

When building a ChartRenderer through code and having varying size charts, you need to set this property so that the renderer's legend information is correct. This property should be set to the largest value for any field for all of the features in the layer.

Specified by:

getMaxValue in interface IChartSymbol

Returns:

The value

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setMaxValue

public void setMaxValue(double value)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IChartSymbol

The maximum value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxValue in interface IChartSymbol

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVerticalBars

public boolean isVerticalBars()
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IBarChartSymbol

Indicates if the bars are oriented vertically.

Supported Platforms

Windows, Solaris, Linux

Description

This property specifies whether or not the chart symbol will be column chart. If True, then it's a column chart with vertical columns. If False, then it's a bar chart with horizontal bars.

Specified by:

isVerticalBars in interface IBarChartSymbol

Returns:

The flag

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalBars

public void setVerticalBars(boolean flag)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IBarChartSymbol

Indicates if the bars are oriented vertically.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVerticalBars in interface IBarChartSymbol

Parameters:

flag - The flag (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isShowAxes

public boolean isShowAxes()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IBarChartSymbol

Indicates if the axis are shown.

Supported Platforms

Windows, Solaris, Linux

Description

This property specifies whether or not x and y axes are shown for the bar/column charts.

Specified by:

isShowAxes in interface IBarChartSymbol

Returns:

The flag

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setShowAxes

public void setShowAxes(boolean flag)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IBarChartSymbol

Indicates if the axis are shown.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowAxes in interface IBarChartSymbol

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAxes

public ILineSymbol getAxes()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IBarChartSymbol

The axis symbol.

Supported Platforms

Windows, Solaris, Linux

Description

This property provides acccess to the line symbol used for the chart x and y axes.

Specified by:

getAxes in interface IBarChartSymbol

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAxes

public void setAxes(ILineSymbol symbol)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IBarChartSymbol

The axis symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAxes in interface IBarChartSymbol

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IBarChartSymbol

The width of each bar in points.

Supported Platforms

Windows, Solaris, Linux

Description

This property provides access to the width of each bar or column in the charts. Only one width can be specified which applies to all of the bars/columns.

Specified by:

getWidth in interface IBarChartSymbol

Returns:

The points

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(double points)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IBarChartSymbol

The width of each bar in points.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface IBarChartSymbol

Parameters:

points - The points (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpacing

public double getSpacing()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IBarChartSymbol

The spacing between bars in points.

Supported Platforms

Windows, Solaris, Linux

Description

This property provides access to the spacing distance between bars or columns.

Specified by:

getSpacing in interface IBarChartSymbol

Returns:

The points

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpacing

public void setSpacing(double points)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IBarChartSymbol

The spacing between bars in points.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpacing in interface IBarChartSymbol

Parameters:

points - The points (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplay3D

public boolean isDisplay3D()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: I3DChartSymbol

Indicates if the chart symbol is 3D.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDisplay3D in interface I3DChartSymbol

Returns:

The flag

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setDisplay3D

public void setDisplay3D(boolean flag)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: I3DChartSymbol

Indicates if the chart symbol is 3D.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplay3D in interface I3DChartSymbol

Parameters:

flag - The flag (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThickness

public double getThickness()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: I3DChartSymbol

3D thickness of the chart symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getThickness in interface I3DChartSymbol

Returns:

The points

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setThickness

public void setThickness(double points)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: I3DChartSymbol

3D thickness of the chart symbol.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setThickness in interface I3DChartSymbol

Parameters:

points - The points (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTilt

public int getTilt()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: I3DChartSymbol

Tilt of 3D Display (0-90 degrees).

Supported Platforms

Windows, Solaris, Linux

Description

Tilt is not supported by the BarChartSymbol coclass.

Specified by:

getTilt in interface I3DChartSymbol

Returns:

The angle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTilt

public void setTilt(int angle)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: I3DChartSymbol

Tilt of 3D Display (0-90 degrees).

Supported Platforms

Windows, Solaris, Linux

Description

Tilt is not supported by the BarChartSymbol coclass.

Specified by:

setTilt in interface I3DChartSymbol

Parameters:

angle - The angle (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.

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.

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.

getBackground

public IMarkerBackground getBackground()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IMarkerBackgroundSupport

The marker background.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackground in interface IMarkerBackgroundSupport

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

public void setBackgroundByRef(IMarkerBackground background)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IMarkerBackgroundSupport

The marker background.

Specified by:

setBackgroundByRef in interface IMarkerBackgroundSupport

Parameters:

background - A reference to a com.esri.arcgis.display.IMarkerBackground (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.