com.esri.arcgis.carto
Interface IACLabelRenderer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ACSimpleLabelRenderer, ACValueMapLabelRenderer, IACLabelRendererProxy

public interface IACLabelRenderer
extends java.io.Serializable

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

Description: 'Provides access to members that control ArcIMS label renderer.' 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 IIDd71e6435_e35b_4ece_9d3f_e8d4bd66ca21
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getFeatureWeight()
          The feature weight to prioritize the importance of features.
 int getHowManyLabels()
          Determines how often a feature will be labeled.
 double getLabelBufferRatio()
          The buffer range around the label where no other labels will overlap.
 java.lang.String getLabelField()
          The name of the Field.
 java.lang.String getLabelProperties()
          The label properties.
 IACSymbol getLabelSymbol()
          Text symbol used to draw the labels.
 int getLabelWeight()
          The label weight to prioritize the importance of labels.
 int getLineLabelPosition()
          Determines where on the line to place the label.
 java.lang.String getRotationalAngles()
          The rotation angle of this label.
 void setFeatureWeight(int weight)
          The feature weight to prioritize the importance of features.
 void setHowManyLabels(int numLabels)
          Determines how often a feature will be labeled.
 void setLabelBufferRatio(double ratio)
          The buffer range around the label where no other labels will overlap.
 void setLabelField(java.lang.String name)
          The name of the Field.
 void setLabelProperties(java.lang.String props)
          The label properties.
 void setLabelSymbol(IACSymbol symbol)
          Text symbol used to draw the labels.
 void setLabelWeight(int weight)
          The label weight to prioritize the importance of labels.
 void setLineLabelPosition(int lineLabelPosition)
          Determines where on the line to place the label.
 void setRotationalAngles(java.lang.String angles)
          The rotation angle of this label.
 

Field Detail

IIDd71e6435_e35b_4ece_9d3f_e8d4bd66ca21

static final int IIDd71e6435_e35b_4ece_9d3f_e8d4bd66ca21
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

getLabelSymbol

IACSymbol getLabelSymbol()
                         throws java.io.IOException,
                                AutomationException
Text symbol used to draw the labels.

Returns:
A reference to a com.esri.arcgis.carto.IACSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelSymbol

void setLabelSymbol(IACSymbol symbol)
                    throws java.io.IOException,
                           AutomationException
Text symbol used to draw the labels.

Parameters:
symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelField

java.lang.String getLabelField()
                               throws java.io.IOException,
                                      AutomationException
The name of the Field.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelField

void setLabelField(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
The name of the Field.

Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureWeight

int getFeatureWeight()
                     throws java.io.IOException,
                            AutomationException
The feature weight to prioritize the importance of features.

Returns:
A com.esri.arcgis.carto.acLabelWeight constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureWeight

void setFeatureWeight(int weight)
                      throws java.io.IOException,
                             AutomationException
The feature weight to prioritize the importance of features.

Parameters:
weight - A com.esri.arcgis.carto.acLabelWeight constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelWeight

int getLabelWeight()
                   throws java.io.IOException,
                          AutomationException
The label weight to prioritize the importance of labels.

Returns:
A com.esri.arcgis.carto.acLabelWeight constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelWeight

void setLabelWeight(int weight)
                    throws java.io.IOException,
                           AutomationException
The label weight to prioritize the importance of labels.

Parameters:
weight - A com.esri.arcgis.carto.acLabelWeight constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelBufferRatio

double getLabelBufferRatio()
                           throws java.io.IOException,
                                  AutomationException
The buffer range around the label where no other labels will overlap.

Returns:
The ratio
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelBufferRatio

void setLabelBufferRatio(double ratio)
                         throws java.io.IOException,
                                AutomationException
The buffer range around the label where no other labels will overlap.

Parameters:
ratio - The ratio (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelProperties

java.lang.String getLabelProperties()
                                    throws java.io.IOException,
                                           AutomationException
The label properties.

Returns:
The props
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelProperties

void setLabelProperties(java.lang.String props)
                        throws java.io.IOException,
                               AutomationException
The label properties.

Parameters:
props - The props (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRotationalAngles

java.lang.String getRotationalAngles()
                                     throws java.io.IOException,
                                            AutomationException
The rotation angle of this label.

Returns:
The angles
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotationalAngles

void setRotationalAngles(java.lang.String angles)
                         throws java.io.IOException,
                                AutomationException
The rotation angle of this label.

Parameters:
angles - The angles (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHowManyLabels

int getHowManyLabels()
                     throws java.io.IOException,
                            AutomationException
Determines how often a feature will be labeled.

Returns:
A com.esri.arcgis.carto.acNumLabels constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHowManyLabels

void setHowManyLabels(int numLabels)
                      throws java.io.IOException,
                             AutomationException
Determines how often a feature will be labeled.

Parameters:
numLabels - A com.esri.arcgis.carto.acNumLabels constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLineLabelPosition

int getLineLabelPosition()
                         throws java.io.IOException,
                                AutomationException
Determines where on the line to place the label.

Returns:
A com.esri.arcgis.carto.acLineLabelPosition constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLineLabelPosition

void setLineLabelPosition(int lineLabelPosition)
                          throws java.io.IOException,
                                 AutomationException
Determines where on the line to place the label.

Parameters:
lineLabelPosition - A com.esri.arcgis.carto.acLineLabelPosition constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.