com.esri.arcgis.carto
Interface ISymbolCollectionElement

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISymbolCollectionElementProxy, ParagraphTextElement, PMFTitleTextElement, TextElement

public interface ISymbolCollectionElement
extends java.io.Serializable

COM Interface 'ISymbolCollectionElement'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides further access to members that control Collection Symbol Elements.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID9aec8465_b8c8_4099_95a8_49815539a8a7
static int	xxDummy Deprecated. Internal use only

Method Summary

void	drawESRIAnno(IStream stream, ISymbolCollection symbolCollection, ISpatialReference spatialRef, IDisplay display) Draws the anno in a compressed format.
void	exportToESRIAnno(IStream stream) Saves the anno in a compressed format.
ITextBackground	getBackground() Background symbol.
double	getCharacterSpacing() The character spacing.
double	getCharacterWidth() The character width.
IColor	getColor() Font color.
double	getFlipAngle() Flip angle.
java.lang.String	getFontName() Font name.
IGeometry	getGeometry() Shape of the element as a geometry.
int	getHorizontalAlignment() Horizontal alignment style.
double	getLeading() The character leading.
int	getOverriddenProperties() Overridden properties.
int	getOverriddenPropertiesExclusionMask() Mask used to exclude overrides when drawing.
ISymbol	getSharedSymbol() Collection symbol.
double	getSize() Font size.
int	getSymbolID() Symbol ID associated with this element.
java.lang.String	getText() Text being displayed by this element.
ITextPath	getTextPath() Text path.
int	getVerticalAlignment() Vertical alignment style.
double	getWordSpacing() The word spacing.
double	getXOffset() Text offset along X-axis.
double	getYOffset() Text offset along Y-axis.
void	importFromESRIAnno(IStream stream, ISpatialReference spatialReference, ISymbolCollection symbolCollection) Loads the anno in a compressed format.
boolean	isBold() Indicates whether bold fonts style.
boolean	isItalic() Indicates whether italic font style.
boolean	isUnderline() Indicates whether underline font style.
IPoint	ISymbolCollectionElement_getAnchorPoint() Callout anchor point.
void	setAnchorPoint(IPoint anchorPoint) Callout anchor point.
void	setBackgroundByRef(ITextBackground symbol) Background symbol.
void	setBold(boolean bold) Indicates whether bold fonts style.
void	setCharacterSpacing(double characterSpacing) The character spacing.
void	setCharacterWidth(double characterWidth) The character width.
void	setColor(IColor color) Font color.
void	setFlipAngle(double flipAngle) Flip angle.
void	setFontName(java.lang.String fontName) Font name.
void	setGeometry(IGeometry pGeometry) Shape of the element as a geometry.
void	setHorizontalAlignment(int horizAlignment) Horizontal alignment style.
void	setItalic(boolean italic) Indicates whether italic font style.
void	setLeading(double leading) The character leading.
void	setOverriddenProperties(int props) Overridden properties.
void	setOverriddenPropertiesExclusionMask(int mask) Mask used to exclude overrides when drawing.
void	setSharedSymbol(int symbolID, ISymbol rhs2) The symbol ID associated with this element.
void	setSize(double pointSize) Font size.
void	setText(java.lang.String text) Text being displayed by this element.
void	setTextPathByRef(ITextPath textPath) Text path.
void	setUnderline(boolean underline) Indicates whether underline font style.
void	setVerticalAlignment(int vertAlignment) Vertical alignment style.
void	setWordSpacing(double wordSpacing) The word spacing.
void	setXOffset(double xOffset) Text offset along X-axis.
void	setYOffset(double yOffset) Text offset along Y-axis.

Field Detail

IID9aec8465_b8c8_4099_95a8_49815539a8a7

static final int IID9aec8465_b8c8_4099_95a8_49815539a8a7

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getSymbolID

int getSymbolID()
                throws java.io.IOException,
                       AutomationException

Symbol ID associated with this element.

Returns:

The symbolID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSharedSymbol

void setSharedSymbol(int symbolID,
                     ISymbol rhs2)
                     throws java.io.IOException,
                            AutomationException

The symbol ID associated with this element.

Parameters:

symbolID - The symbolID (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSharedSymbol

ISymbol getSharedSymbol()
                        throws java.io.IOException,
                               AutomationException

Collection symbol.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exportToESRIAnno

void exportToESRIAnno(IStream stream)
                      throws java.io.IOException,
                             AutomationException

Saves the anno in a compressed format.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

importFromESRIAnno

void importFromESRIAnno(IStream stream,
                        ISpatialReference spatialReference,
                        ISymbolCollection symbolCollection)
                        throws java.io.IOException,
                               AutomationException

Loads the anno in a compressed format.

Parameters:

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

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawESRIAnno

void drawESRIAnno(IStream stream,
                  ISymbolCollection symbolCollection,
                  ISpatialReference spatialRef,
                  IDisplay display)
                  throws java.io.IOException,
                         AutomationException

Draws the anno in a compressed format.

Parameters:

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

symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)

spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXOffset

double getXOffset()
                  throws java.io.IOException,
                         AutomationException

Text offset along X-axis.

Returns:

The xOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXOffset

void setXOffset(double xOffset)
                throws java.io.IOException,
                       AutomationException

Text offset along X-axis.

Parameters:

xOffset - The xOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYOffset

double getYOffset()
                  throws java.io.IOException,
                         AutomationException

Text offset along Y-axis.

Returns:

The yOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYOffset

void setYOffset(double yOffset)
                throws java.io.IOException,
                       AutomationException

Text offset along Y-axis.

Parameters:

yOffset - The yOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVerticalAlignment

int getVerticalAlignment()
                         throws java.io.IOException,
                                AutomationException

Vertical alignment style.

Returns:

A com.esri.arcgis.display.esriTextVerticalAlignment constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVerticalAlignment

void setVerticalAlignment(int vertAlignment)
                          throws java.io.IOException,
                                 AutomationException

Vertical alignment style.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

int getHorizontalAlignment()
                           throws java.io.IOException,
                                  AutomationException

Horizontal alignment style.

Returns:

A com.esri.arcgis.display.esriTextHorizontalAlignment constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

void setHorizontalAlignment(int horizAlignment)
                            throws java.io.IOException,
                                   AutomationException

Horizontal alignment style.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFlipAngle

double getFlipAngle()
                    throws java.io.IOException,
                           AutomationException

Flip angle.

Returns:

The flipAngle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFlipAngle

void setFlipAngle(double flipAngle)
                  throws java.io.IOException,
                         AutomationException

Flip angle.

Parameters:

flipAngle - The flipAngle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

ISymbolCollectionElement_getAnchorPoint

IPoint ISymbolCollectionElement_getAnchorPoint()
                                               throws java.io.IOException,
                                                      AutomationException

Callout anchor point.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnchorPoint

void setAnchorPoint(IPoint anchorPoint)
                    throws java.io.IOException,
                           AutomationException

Callout anchor point.

Parameters:

anchorPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSize

double getSize()
               throws java.io.IOException,
                      AutomationException

Font size.

Returns:

The pointSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSize

void setSize(double pointSize)
             throws java.io.IOException,
                    AutomationException

Font size.

Parameters:

pointSize - The pointSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColor

IColor getColor()
                throws java.io.IOException,
                       AutomationException

Font color.

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

void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException

Font color.

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.

getTextPath

ITextPath getTextPath()
                      throws java.io.IOException,
                             AutomationException

Text path.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextPathByRef

void setTextPathByRef(ITextPath textPath)
                      throws java.io.IOException,
                             AutomationException

Text path.

Parameters:

textPath - A reference to a com.esri.arcgis.display.ITextPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCharacterSpacing

double getCharacterSpacing()
                           throws java.io.IOException,
                                  AutomationException

The character spacing.

Returns:

The characterSpacing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

void setCharacterSpacing(double characterSpacing)
                         throws java.io.IOException,
                                AutomationException

The character spacing.

Parameters:

characterSpacing - The characterSpacing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

double getCharacterWidth()
                         throws java.io.IOException,
                                AutomationException

The character width.

Returns:

The characterWidth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

void setCharacterWidth(double characterWidth)
                       throws java.io.IOException,
                              AutomationException

The character width.

Parameters:

characterWidth - The characterWidth (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

double getWordSpacing()
                      throws java.io.IOException,
                             AutomationException

The word spacing.

Returns:

The wordSpacing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWordSpacing

void setWordSpacing(double wordSpacing)
                    throws java.io.IOException,
                           AutomationException

The word spacing.

Parameters:

wordSpacing - The wordSpacing (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLeading

double getLeading()
                  throws java.io.IOException,
                         AutomationException

The character leading.

Returns:

The leading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLeading

void setLeading(double leading)
                throws java.io.IOException,
                       AutomationException

The character leading.

Parameters:

leading - The leading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBold

boolean isBold()
               throws java.io.IOException,
                      AutomationException

Indicates whether bold fonts style.

Returns:

The bold

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBold

void setBold(boolean bold)
             throws java.io.IOException,
                    AutomationException

Indicates whether bold fonts style.

Parameters:

bold - The bold (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFontName

java.lang.String getFontName()
                             throws java.io.IOException,
                                    AutomationException

Font name.

Returns:

The fontName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFontName

void setFontName(java.lang.String fontName)
                 throws java.io.IOException,
                        AutomationException

Font name.

Parameters:

fontName - The fontName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isItalic

boolean isItalic()
                 throws java.io.IOException,
                        AutomationException

Indicates whether italic font style.

Returns:

The italic

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setItalic

void setItalic(boolean italic)
               throws java.io.IOException,
                      AutomationException

Indicates whether italic font style.

Parameters:

italic - The italic (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUnderline

boolean isUnderline()
                    throws java.io.IOException,
                           AutomationException

Indicates whether underline font style.

Returns:

The underline

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUnderline

void setUnderline(boolean underline)
                  throws java.io.IOException,
                         AutomationException

Indicates whether underline font style.

Parameters:

underline - The underline (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackground

ITextBackground getBackground()
                              throws java.io.IOException,
                                     AutomationException

Background symbol.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

void setBackgroundByRef(ITextBackground symbol)
                        throws java.io.IOException,
                               AutomationException

Background symbol.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverriddenProperties

void setOverriddenProperties(int props)
                             throws java.io.IOException,
                                    AutomationException

Overridden properties.

Parameters:

props - The props (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOverriddenProperties

int getOverriddenProperties()
                            throws java.io.IOException,
                                   AutomationException

Overridden properties.

Returns:

The props

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOverriddenPropertiesExclusionMask

void setOverriddenPropertiesExclusionMask(int mask)
                                          throws java.io.IOException,
                                                 AutomationException

Mask used to exclude overrides when drawing.

Parameters:

mask - The mask (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOverriddenPropertiesExclusionMask

int getOverriddenPropertiesExclusionMask()
                                         throws java.io.IOException,
                                                AutomationException

Mask used to exclude overrides when drawing.

Returns:

The mask

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getText

java.lang.String getText()
                         throws java.io.IOException,
                                AutomationException

Text being displayed by this element.

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setText

void setText(java.lang.String text)
             throws java.io.IOException,
                    AutomationException

Text being displayed by this element.

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

Shape of the element as a geometry.

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeometry

void setGeometry(IGeometry pGeometry)
                 throws java.io.IOException,
                        AutomationException

Shape of the element as a geometry.

Parameters:

pGeometry - 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.