com.esri.arcgis.carto
Interface IAnnotateLayerProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IAnnotateLayerPropertiesProxy, LabelEngineLayerProperties, MaplexLabelEngineLayerProperties

public interface IAnnotateLayerProperties
extends java.io.Serializable

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

Description: 'Provides access to members that work with the display of dynamic labels (text) for a feature layer.' 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	IID01004142_0d1c_11d2_a26f_080009b6f22b
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	esri_getClass() The class name.
double	getAnnotationMaximumScale() The maximum scale at which to display annotation.
double	getAnnotationMinimumScale() The minimum scale at which to display annotation.
IEnvelope	getExtent() The extent to perform labeling in.
IFeatureLayer	getFeatureLayer() The annotated feature class.
IGraphicsContainer	getGraphicsContainer() The output graphics container for placed labels.
int	getLabelWhichFeatures() The type of features labeled.
int	getPriority() Priority for labels of this feature class (0 is highest).
java.lang.String	getWhereClause() SQL where clause that determines which features are labeled.
boolean	isAddUnplacedToGraphicsContainer() Indicates if overflow labels are put into a graphics container.
boolean	isCreateUnplacedElements() Indicates if unplaced elements are created.
boolean	isDisplayAnnotation() Indicates if the layer displays annotation.
boolean	isFeatureLinked() Indicates if the text is feature linked.
boolean	isUseOutput() Indicates if the output will be used.
void	setAddUnplacedToGraphicsContainer(boolean value) Indicates if overflow labels are put into a graphics container.
void	setAnnotationMaximumScale(double maxScale) The maximum scale at which to display annotation.
void	setAnnotationMinimumScale(double minScale) The minimum scale at which to display annotation.
void	setClass(java.lang.String className) The class name.
void	setCreateUnplacedElements(boolean flag) Indicates if unplaced elements are created.
void	setDisplayAnnotation(boolean value) Indicates if the layer displays annotation.
void	setExtent(IEnvelope extent) The extent to perform labeling in.
void	setFeatureLayerByRef(IFeatureLayer featureLayer) The annotated feature class.
void	setFeatureLinked(boolean flag) Indicates if the text is feature linked.
void	setGraphicsContainerByRef(IGraphicsContainer graphicsContainer) The output graphics container for placed labels.
void	setLabelWhichFeatures(int type) The type of features labeled.
void	setPriority(int priority) Priority for labels of this feature class (0 is highest).
void	setUseOutput(boolean set) Indicates if the output will be used.
void	setWhereClause(java.lang.String whereClause) SQL where clause that determines which features are labeled.

Field Detail

IID01004142_0d1c_11d2_a26f_080009b6f22b

static final int IID01004142_0d1c_11d2_a26f_080009b6f22b

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

setUseOutput

void setUseOutput(boolean set)
                  throws java.io.IOException,
                         AutomationException

Indicates if the output will be used.

Parameters:

set - The set (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseOutput

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

Indicates if the output will be used.

Returns:

The set

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The extent to perform labeling in.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException

The extent to perform labeling in.

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureLayer

IFeatureLayer getFeatureLayer()
                              throws java.io.IOException,
                                     AutomationException

The annotated feature class.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureLayerByRef

void setFeatureLayerByRef(IFeatureLayer featureLayer)
                          throws java.io.IOException,
                                 AutomationException

The annotated feature class.

Parameters:

featureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClass

void setClass(java.lang.String className)
              throws java.io.IOException,
                     AutomationException

The class name.

Parameters:

className - The className (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

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

The class name.

Returns:

The className

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelWhichFeatures

void setLabelWhichFeatures(int type)
                           throws java.io.IOException,
                                  AutomationException

The type of features labeled.

Parameters:

type - A com.esri.arcgis.carto.esriLabelWhichFeatures constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelWhichFeatures

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

The type of features labeled.

Returns:

A com.esri.arcgis.carto.esriLabelWhichFeatures constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCreateUnplacedElements

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

Indicates if unplaced elements are created.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCreateUnplacedElements

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

Indicates if unplaced elements are created.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnnotationMinimumScale

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

The minimum scale at which to display annotation.

Returns:

The minScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnnotationMinimumScale

void setAnnotationMinimumScale(double minScale)
                               throws java.io.IOException,
                                      AutomationException

The minimum scale at which to display annotation.

Parameters:

minScale - The minScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnnotationMaximumScale

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

The maximum scale at which to display annotation.

Returns:

The maxScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAnnotationMaximumScale

void setAnnotationMaximumScale(double maxScale)
                               throws java.io.IOException,
                                      AutomationException

The maximum scale at which to display annotation.

Parameters:

maxScale - The maxScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureLinked

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

Indicates if the text is feature linked.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFeatureLinked

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

Indicates if the text is feature linked.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPriority

void setPriority(int priority)
                 throws java.io.IOException,
                        AutomationException

Priority for labels of this feature class (0 is highest).

Parameters:

priority - The priority (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPriority

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

Priority for labels of this feature class (0 is highest).

Returns:

The priority

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayAnnotation

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

Indicates if the layer displays annotation.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

void setDisplayAnnotation(boolean value)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the layer displays annotation.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException

SQL where clause that determines which features are labeled.

Parameters:

whereClause - The whereClause (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWhereClause

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

SQL where clause that determines which features are labeled.

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGraphicsContainerByRef

void setGraphicsContainerByRef(IGraphicsContainer graphicsContainer)
                               throws java.io.IOException,
                                      AutomationException

The output graphics container for placed labels.

Parameters:

graphicsContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGraphicsContainer

IGraphicsContainer getGraphicsContainer()
                                        throws java.io.IOException,
                                               AutomationException

The output graphics container for placed labels.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAddUnplacedToGraphicsContainer

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

Indicates if overflow labels are put into a graphics container.

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddUnplacedToGraphicsContainer

void setAddUnplacedToGraphicsContainer(boolean value)
                                       throws java.io.IOException,
                                              AutomationException

Indicates if overflow labels are put into a graphics container.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.