com.esri.arcgis.display
Class IDynamicSymbolPropertiesProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.display.IDynamicSymbolPropertiesProxy

All Implemented Interfaces:

IDynamicSymbolProperties, Externalizable, Serializable

Direct Known Subclasses:

IDynamicSymbolProperties2Proxy

public class IDynamicSymbolPropertiesProxy
extends com.esri.arcgis.interop.Dispatch
implements IDynamicSymbolProperties, Serializable

Provides access to dynamic symbol properties.

Superseded By

IDynamicSymbolProperties2

Remarks

The Dynamic Display has four internal Dynamic Symbols that are being used to determine how the Dynamic Items are to be rendered. These internal Dynamic Symbols are:

· Dynamic Marker Symbol

· Dynamic Line Symbol

· Dynamic Fill Symbol

· Dynamic Text Symbol

The IDynamicSymbolProperties interface is used in order to set these four Dynamic Symbols’ Properties.

Each Dynamic Item that is rendered will be affected by the current state of the Internal Dynamic Symbols. For example, when DrawPolygon method is being called, the polygon’s fill will be rendered according to the current state of the internal Dynamic Fill Symbol, and the Polygon’s outline will be rendered according to the current state of the internal Dynamic Line Symbol.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IDynamicSymbolPropertiesProxy()
	IDynamicSymbolPropertiesProxy(Object obj)
protected	IDynamicSymbolPropertiesProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	getColor(int dynamicSymbolType, float[] red, float[] green, float[] blue, float[] alpha) Indicates the color for the specified dynamic symbol.
IDynamicGlyph	getDynamicGlyph(int dynamicSymbolType) Indicates the dynamic glyph for the specified dynamic symbol.
float	getHeading(int dynamicSymbolType) Indicates the heading for the specified dynamic symbol, relative to the rotation alignment.
int	getRotationAlignment(int dynamicSymbolType) Indicates the rotation alignment for the specified dynamic symbol.
void	getScale(int dynamicSymbolType, float[] scaleX, float[] scaleY) Scales the dynamic symbol.
int	getTextHorizontalAlignment() Indicates the horizontal alignment for the dynamic text symbol.
int	getTextVerticalAlignment() Indicates the vertical alignment for the dynamic text symbol.
boolean	isSmooth(int dynamicSymbolType) Indicates whether the specified dynamic symbol will be smooth.
void	removeListener(String iidStr, Object theListener)
void	setColor(int dynamicSymbolType, float red, float green, float blue, float alpha) Indicates the color for the specified dynamic symbol.
void	setDynamicGlyphByRef(int dynamicSymbolType, IDynamicGlyph dynamicGlyph) Indicates the dynamic glyph for the specified dynamic symbol.
void	setHeading(int dynamicSymbolType, float heading) Indicates the heading for the specified dynamic symbol, relative to the rotation alignment.
void	setRotationAlignment(int dynamicSymbolType, int dynamicSymbolRotationAlignment) Indicates the rotation alignment for the specified dynamic symbol.
void	setScale(int dynamicSymbolType, float scaleX, float scaleY) Scales the dynamic symbol.
void	setSmooth(int dynamicSymbolType, boolean smooth) Indicates whether the specified dynamic symbol will be smooth.
void	setTextHorizontalAlignment(int horizontalAlignment) Indicates the horizontal alignment for the dynamic text symbol.
void	setTextVerticalAlignment(int verticalAlignment) Indicates the vertical alignment for the dynamic text symbol.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IDynamicSymbolPropertiesProxy

public IDynamicSymbolPropertiesProxy()

IDynamicSymbolPropertiesProxy

public IDynamicSymbolPropertiesProxy(Object obj)
                              throws IOException

Throws:

IOException

IDynamicSymbolPropertiesProxy

protected IDynamicSymbolPropertiesProxy(Object obj,
                                        String iid)
                                 throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getDynamicGlyph

public IDynamicGlyph getDynamicGlyph(int dynamicSymbolType)
                              throws IOException,
                                     AutomationException

Indicates the dynamic glyph for the specified dynamic symbol.

Product Availability

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

Specified by:

getDynamicGlyph in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDynamicGlyphByRef

public void setDynamicGlyphByRef(int dynamicSymbolType,
                                 IDynamicGlyph dynamicGlyph)
                          throws IOException,
                                 AutomationException

Indicates the dynamic glyph for the specified dynamic symbol.

Remarks

Dynamic Glyph is a handle to a graphic resource that can be used in order to render the Dynamic Symbol.Use the Dynamic Glyph Factory in order to create and delete Dynamic Glyphs.

Product Availability

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

Specified by:

setDynamicGlyphByRef in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

dynamicGlyph - A reference to a com.esri.arcgis.display.IDynamicGlyph (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScale

public void getScale(int dynamicSymbolType,
                     float[] scaleX,
                     float[] scaleY)
              throws IOException,
                     AutomationException

Scales the dynamic symbol.

Description

Gets the current relative scale for the specified dynamic symbol (text, marker, line, fill).

Remarks

The scale attribute can be used in order to reuse a glyph, and render it in different sizes, rather than creating a different glyph for each different size. This is recommended in order to minimize graphic resources usage.

Product Availability

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

Specified by:

getScale in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

scaleX - The scaleX (in/out: use single element array)

scaleY - The scaleY (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScale

public void setScale(int dynamicSymbolType,
                     float scaleX,
                     float scaleY)
              throws IOException,
                     AutomationException

Scales the dynamic symbol.

Description

Sets the current relative scale for the specified dynamic symbol (text, marker, line, fill).

Remarks

The scale attribute can be used in order to reuse a glyph, and render it in different sizes, rather than creating a different glyph for each different size. This is recommended in order to minimize graphic resources usage.

Product Availability

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

Specified by:

setScale in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

scaleX - The scaleX (in)

scaleY - The scaleY (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

public void getColor(int dynamicSymbolType,
                     float[] red,
                     float[] green,
                     float[] blue,
                     float[] alpha)
              throws IOException,
                     AutomationException

Indicates the color for the specified dynamic symbol.

Remarks

The color attribute can be used in order to reuse a glyph, and render it in different colors, if possible, rather than creating a different glyph for each color. This is recommended in order to minimize graphic resources usage, and is possible with monochromatic symbols.

For monochromatic symbols (symbols that consist of only one color and might even have fixed black pixels), it is advisable to create a white-and-black dynamic glyph, and then set the DynamicSymbol’s color to the desired color. That will result in coloring the white pixels to the desired color, while leaving the black colors black. That method enables you to reuse a white-and-black glyph to draw different colors of the same glyph.

For multicolor symbols (symbols that contain more than just white and black colors in them), it is advisable to create the multicolor glyph, and then set the DynamicSymbol’s color to white. That will result in rendering the original colors of the glyph’s pixels.Use the alpha value in order to affect the Dynamic Symbol’s transparency level.

The target pixel color is being calculated by multiplying the Glyph’s color value with the value of the Color Property. For example - a white opaque color (R=1, G=1, B=1, A=1) will result in rendering the pixels with the original glyph’s color values, with the same transparency level.

Product Availability

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

Specified by:

getColor in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

red - The red (in/out: use single element array)

green - The green (in/out: use single element array)

blue - The blue (in/out: use single element array)

alpha - The alpha (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColor

public void setColor(int dynamicSymbolType,
                     float red,
                     float green,
                     float blue,
                     float alpha)
              throws IOException,
                     AutomationException

Indicates the color for the specified dynamic symbol.

Remarks

The color attribute can be used in order to reuse a glyph, and render it in different colors, if possible, rather than creating a different glyph for each color. This is recommended in order to minimize graphic resources usage, and is possible with monochromatic symbols.

For monochromatic symbols (symbols that consist of only one color and might even have fixed black pixels), it is advisable to create a white-and-black dynamic glyph, and then set the DynamicSymbol’s color to the desired color. That will result in coloring the white pixels to the desired color, while leaving the black colors black. That method enables you to reuse a white-and-black glyph to draw different colors of the same glyph.

For multicolor symbols (symbols that contain more than just white and black colors in them), it is advisable to create the multicolor glyph, and then set the DynamicSymbol’s color to white. That will result in rendering the original colors of the glyph’s pixels.Use the alpha value in order to affect the Dynamic Symbol’s transparency level.

The target pixel color is being calculated by multiplying the Glyph’s color value with the value of the Color Property. For example - a white opaque color (R=1, G=1, B=1, A=1) will result in rendering the pixels with the original glyph’s color values, with the same transparency level.

Product Availability

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

Specified by:

setColor in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

red - The red (in)

green - The green (in)

blue - The blue (in)

alpha - The alpha (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotationAlignment

public int getRotationAlignment(int dynamicSymbolType)
                         throws IOException,
                                AutomationException

Indicates the rotation alignment for the specified dynamic symbol.

Product Availability

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

Specified by:

getRotationAlignment in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

Returns:

A com.esri.arcgis.display.esriDynamicSymbolRotationAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotationAlignment

public void setRotationAlignment(int dynamicSymbolType,
                                 int dynamicSymbolRotationAlignment)
                          throws IOException,
                                 AutomationException

Indicates the rotation alignment for the specified dynamic symbol.

Product Availability

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

Specified by:

setRotationAlignment in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

dynamicSymbolRotationAlignment - A com.esri.arcgis.display.esriDynamicSymbolRotationAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeading

public float getHeading(int dynamicSymbolType)
                 throws IOException,
                        AutomationException

Indicates the heading for the specified dynamic symbol, relative to the rotation alignment.

Product Availability

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

Specified by:

getHeading in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

Returns:

The heading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeading

public void setHeading(int dynamicSymbolType,
                       float heading)
                throws IOException,
                       AutomationException

Indicates the heading for the specified dynamic symbol, relative to the rotation alignment.

Product Availability

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

Specified by:

setHeading in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

heading - The heading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSmooth

public boolean isSmooth(int dynamicSymbolType)
                 throws IOException,
                        AutomationException

Indicates whether the specified dynamic symbol will be smooth.

Product Availability

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

Specified by:

isSmooth in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

Returns:

The smooth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSmooth

public void setSmooth(int dynamicSymbolType,
                      boolean smooth)
               throws IOException,
                      AutomationException

Indicates whether the specified dynamic symbol will be smooth.

Product Availability

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

Specified by:

setSmooth in interface IDynamicSymbolProperties

Parameters:

dynamicSymbolType - A com.esri.arcgis.display.esriDynamicSymbolType constant (in)

smooth - The smooth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextVerticalAlignment

public int getTextVerticalAlignment()
                             throws IOException,
                                    AutomationException

Indicates the vertical alignment for the dynamic text symbol.

Remarks

This property affects the anchor point of the text.

Product Availability

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

Specified by:

getTextVerticalAlignment in interface IDynamicSymbolProperties

Returns:

A com.esri.arcgis.display.esriTextVerticalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextVerticalAlignment

public void setTextVerticalAlignment(int verticalAlignment)
                              throws IOException,
                                     AutomationException

Indicates the vertical alignment for the dynamic text symbol.

Remarks

This property affects the anchor point of the text.

Product Availability

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

Specified by:

setTextVerticalAlignment in interface IDynamicSymbolProperties

Parameters:

verticalAlignment - A com.esri.arcgis.display.esriTextVerticalAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextHorizontalAlignment

public int getTextHorizontalAlignment()
                               throws IOException,
                                      AutomationException

Indicates the horizontal alignment for the dynamic text symbol.

Remarks

This property affects the anchor point of the text.

Product Availability

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

Specified by:

getTextHorizontalAlignment in interface IDynamicSymbolProperties

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextHorizontalAlignment

public void setTextHorizontalAlignment(int horizontalAlignment)
                                throws IOException,
                                       AutomationException

Indicates the horizontal alignment for the dynamic text symbol.

Remarks

This property affects the anchor point of the text.

Product Availability

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

Specified by:

setTextHorizontalAlignment in interface IDynamicSymbolProperties

Parameters:

horizontalAlignment - A com.esri.arcgis.display.esriTextHorizontalAlignment constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.