com.esri.arcgis.carto
Class MaplexLabelEngineLayerProperties

java.lang.Object
  extended by com.esri.arcgis.carto.MaplexLabelEngineLayerProperties
All Implemented Interfaces:
IAnnotateLayerProperties, IAnnotateLayerTransformationProperties, IAnnotateProperties, ILabelEngineLayerProperties, ILabelEngineLayerProperties2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MaplexLabelEngineLayerProperties
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotateProperties, IAnnotateLayerProperties, ILabelEngineLayerProperties, ILabelEngineLayerProperties2, IAnnotateLayerTransformationProperties, IPersistStream, IClone, java.io.Externalizable

COM Class 'MaplexLabelEngineLayerProperties'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Properties that specify the labeling of a layer and conversion of labels to annotation.' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IAnnotateProperties
IID, IID01004141_0d1c_11d2_a26f_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IAnnotateLayerProperties
IID, IID01004142_0d1c_11d2_a26f_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILabelEngineLayerProperties
IID, IID01004143_0d1c_11d2_a26f_080009b6f22b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.ILabelEngineLayerProperties2
IID, IID59a8eeba_8ef7_4143_b497_4efcaf6a2405, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IAnnotateLayerTransformationProperties
IID, IID3eb7ef02_dd8b_11d2_9f47_00c04f6bc6a5, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Constructor Summary
MaplexLabelEngineLayerProperties()
          Constructs a MaplexLabelEngineLayerProperties using ArcGIS Engine.
MaplexLabelEngineLayerProperties(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexLabelEngineLayerProperties theMaplexLabelEngineLayerProperties = (MaplexLabelEngineLayerProperties) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 java.lang.String esri_getClass()
          The class name.
 int getAnnotationClassID()
          The ID of the annotation class.
 double getAnnotationMaximumScale()
          The maximum scale at which to display annotation.
 double getAnnotationMinimumScale()
          The minimum scale at which to display annotation.
 IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 IEnvelope getBounds()
          The full extent in world coordinates.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.String getExpression()
          The VBScript or JScript expression that evaluates and formats the label.
 IAnnotationExpressionEngine getExpressionParser()
          The object that interprets the expression.
 IEnvelope getExtent()
          The extent to perform labeling in.
 IFeatureLayer getFeatureLayer()
          The annotated feature class.
 IGraphicsContainer getGraphicsContainer()
          The output graphics container for placed labels.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getLabelWhichFeatures()
          The type of features labeled.
 double getOffset()
          The offset between the label and the feature.
 IOverposterLayerProperties getOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 int getPriority()
          Priority for labels of this feature class (0 is highest).
 double getReferenceScale()
          Reference scale for computing scaled symbol sizes.
 double getScaleRatio()
          Scale ratio of the transformation.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ITextSymbol getSymbol()
          The text symbol used to draw the label.
 int getSymbolID()
          The ID of the group symbol used to draw the label.
 int getUnits()
          The units of the world coordinates.
 java.lang.String getWhereClause()
          SQL where clause that determines which features are labeled.
 int hashCode()
          the hashcode for this object
 boolean isAddUnplacedToGraphicsContainer()
          Indicates if overflow labels are put into a graphics container.
 boolean isCreateUnplacedElements()
          Indicates if unplaced elements are created.
 void isDirty()
          isDirty
 boolean isDisplayAnnotation()
          Indicates if the layer displays annotation.
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isExpressionSimple()
          Indicates if the expression is simple.
 boolean isFeatureLinked()
          Indicates if the text is feature linked.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isUseOutput()
          Indicates if the output will be used.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a MaplexLabelEngineLayerProperties.
 void save(IStream pstm, int fClearDirty)
          save
 void setAddUnplacedToGraphicsContainer(boolean value)
          Indicates if overflow labels are put into a graphics container.
 void setAnnotationClassID(int annotationClassID)
          The ID of the annotation class.
 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 setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
          The overposter properties, which specify how labels are placed relative to features.
 void setBounds(IEnvelope bounds)
          The full extent in world coordinates.
 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 setExpression(java.lang.String expression)
          The VBScript or JScript expression that evaluates and formats the label.
 void setExpressionParserByRef(IAnnotationExpressionEngine engine)
          The object that interprets the expression.
 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 setIsExpressionSimple(boolean simpleExpression)
          Indicates if the expression is simple.
 void setLabelWhichFeatures(int type)
          The type of features labeled.
 void setOffset(double offset)
          The offset between the label and the feature.
 void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
          The overposter properties, which specify how labels are placed relative to features.
 void setPriority(int priority)
          Priority for labels of this feature class (0 is highest).
 void setReferenceScale(double scale)
          Reference scale for computing scaled symbol sizes.
 void setScaleRatio(double scale)
          Scale ratio of the transformation.
 void setSymbolByRef(ITextSymbol textSymbol)
          The text symbol used to draw the label.
 void setSymbolID(int pSymbolID)
          The ID of the group symbol used to draw the label.
 void setUnits(int unitsCode)
          The units of the world coordinates.
 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.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

MaplexLabelEngineLayerProperties

public MaplexLabelEngineLayerProperties()
                                 throws java.io.IOException,
                                        java.net.UnknownHostException
Constructs a MaplexLabelEngineLayerProperties using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

MaplexLabelEngineLayerProperties

public MaplexLabelEngineLayerProperties(java.lang.Object obj)
                                 throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexLabelEngineLayerProperties theMaplexLabelEngineLayerProperties = (MaplexLabelEngineLayerProperties) obj;

Construct a MaplexLabelEngineLayerProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MaplexLabelEngineLayerProperties.

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()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a MaplexLabelEngineLayerProperties.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setUseOutput

public void setUseOutput(boolean set)
                  throws java.io.IOException,
                         AutomationException
Indicates if the output will be used.

Specified by:
setUseOutput in interface IAnnotateLayerProperties
Parameters:
set - The set (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseOutput

public boolean isUseOutput()
                    throws java.io.IOException,
                           AutomationException
Indicates if the output will be used.

Specified by:
isUseOutput in interface IAnnotateLayerProperties
Returns:
The set
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The extent to perform labeling in.

Specified by:
getExtent in interface IAnnotateLayerProperties
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

public void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException
The extent to perform labeling in.

Specified by:
setExtent in interface IAnnotateLayerProperties
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

public IFeatureLayer getFeatureLayer()
                              throws java.io.IOException,
                                     AutomationException
The annotated feature class.

Specified by:
getFeatureLayer in interface IAnnotateLayerProperties
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

public void setFeatureLayerByRef(IFeatureLayer featureLayer)
                          throws java.io.IOException,
                                 AutomationException
The annotated feature class.

Specified by:
setFeatureLayerByRef in interface IAnnotateLayerProperties
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

public void setClass(java.lang.String className)
              throws java.io.IOException,
                     AutomationException
The class name.

Specified by:
setClass in interface IAnnotateLayerProperties
Parameters:
className - The className (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_getClass

public java.lang.String esri_getClass()
                               throws java.io.IOException,
                                      AutomationException
The class name.

Specified by:
esri_getClass in interface IAnnotateLayerProperties
Returns:
The className
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelWhichFeatures

public void setLabelWhichFeatures(int type)
                           throws java.io.IOException,
                                  AutomationException
The type of features labeled.

Specified by:
setLabelWhichFeatures in interface IAnnotateLayerProperties
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

public int getLabelWhichFeatures()
                          throws java.io.IOException,
                                 AutomationException
The type of features labeled.

Specified by:
getLabelWhichFeatures in interface IAnnotateLayerProperties
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

public void setCreateUnplacedElements(boolean flag)
                               throws java.io.IOException,
                                      AutomationException
Indicates if unplaced elements are created.

Specified by:
setCreateUnplacedElements in interface IAnnotateLayerProperties
Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCreateUnplacedElements

public boolean isCreateUnplacedElements()
                                 throws java.io.IOException,
                                        AutomationException
Indicates if unplaced elements are created.

Specified by:
isCreateUnplacedElements in interface IAnnotateLayerProperties
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationMinimumScale

public double getAnnotationMinimumScale()
                                 throws java.io.IOException,
                                        AutomationException
The minimum scale at which to display annotation.

Specified by:
getAnnotationMinimumScale in interface IAnnotateLayerProperties
Returns:
The minScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationMinimumScale

public void setAnnotationMinimumScale(double minScale)
                               throws java.io.IOException,
                                      AutomationException
The minimum scale at which to display annotation.

Specified by:
setAnnotationMinimumScale in interface IAnnotateLayerProperties
Parameters:
minScale - The minScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationMaximumScale

public double getAnnotationMaximumScale()
                                 throws java.io.IOException,
                                        AutomationException
The maximum scale at which to display annotation.

Specified by:
getAnnotationMaximumScale in interface IAnnotateLayerProperties
Returns:
The maxScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationMaximumScale

public void setAnnotationMaximumScale(double maxScale)
                               throws java.io.IOException,
                                      AutomationException
The maximum scale at which to display annotation.

Specified by:
setAnnotationMaximumScale in interface IAnnotateLayerProperties
Parameters:
maxScale - The maxScale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureLinked

public void setFeatureLinked(boolean flag)
                      throws java.io.IOException,
                             AutomationException
Indicates if the text is feature linked.

Specified by:
setFeatureLinked in interface IAnnotateLayerProperties
Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFeatureLinked

public boolean isFeatureLinked()
                        throws java.io.IOException,
                               AutomationException
Indicates if the text is feature linked.

Specified by:
isFeatureLinked in interface IAnnotateLayerProperties
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriority

public void setPriority(int priority)
                 throws java.io.IOException,
                        AutomationException
Priority for labels of this feature class (0 is highest).

Specified by:
setPriority in interface IAnnotateLayerProperties
Parameters:
priority - The priority (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws java.io.IOException,
                       AutomationException
Priority for labels of this feature class (0 is highest).

Specified by:
getPriority in interface IAnnotateLayerProperties
Returns:
The priority
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDisplayAnnotation

public boolean isDisplayAnnotation()
                            throws java.io.IOException,
                                   AutomationException
Indicates if the layer displays annotation.

Specified by:
isDisplayAnnotation in interface IAnnotateLayerProperties
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

public void setDisplayAnnotation(boolean value)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the layer displays annotation.

Specified by:
setDisplayAnnotation in interface IAnnotateLayerProperties
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException
SQL where clause that determines which features are labeled.

Specified by:
setWhereClause in interface IAnnotateLayerProperties
Parameters:
whereClause - The whereClause (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException
SQL where clause that determines which features are labeled.

Specified by:
getWhereClause in interface IAnnotateLayerProperties
Returns:
The whereClause
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGraphicsContainerByRef

public void setGraphicsContainerByRef(IGraphicsContainer graphicsContainer)
                               throws java.io.IOException,
                                      AutomationException
The output graphics container for placed labels.

Specified by:
setGraphicsContainerByRef in interface IAnnotateLayerProperties
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

public IGraphicsContainer getGraphicsContainer()
                                        throws java.io.IOException,
                                               AutomationException
The output graphics container for placed labels.

Specified by:
getGraphicsContainer in interface IAnnotateLayerProperties
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

public boolean isAddUnplacedToGraphicsContainer()
                                         throws java.io.IOException,
                                                AutomationException
Indicates if overflow labels are put into a graphics container.

Specified by:
isAddUnplacedToGraphicsContainer in interface IAnnotateLayerProperties
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddUnplacedToGraphicsContainer

public void setAddUnplacedToGraphicsContainer(boolean value)
                                       throws java.io.IOException,
                                              AutomationException
Indicates if overflow labels are put into a graphics container.

Specified by:
setAddUnplacedToGraphicsContainer in interface IAnnotateLayerProperties
Parameters:
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(ITextSymbol textSymbol)
                    throws java.io.IOException,
                           AutomationException
The text symbol used to draw the label.

Specified by:
setSymbolByRef in interface ILabelEngineLayerProperties
Specified by:
setSymbolByRef in interface ILabelEngineLayerProperties2
Parameters:
textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws java.io.IOException,
                             AutomationException
The text symbol used to draw the label.

Specified by:
getSymbol in interface ILabelEngineLayerProperties
Specified by:
getSymbol in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolID

public void setSymbolID(int pSymbolID)
                 throws java.io.IOException,
                        AutomationException
The ID of the group symbol used to draw the label.

Specified by:
setSymbolID in interface ILabelEngineLayerProperties
Specified by:
setSymbolID in interface ILabelEngineLayerProperties2
Parameters:
pSymbolID - The pSymbolID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolID

public int getSymbolID()
                throws java.io.IOException,
                       AutomationException
The ID of the group symbol used to draw the label.

Specified by:
getSymbolID in interface ILabelEngineLayerProperties
Specified by:
getSymbolID in interface ILabelEngineLayerProperties2
Returns:
The pSymbolID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffset

public void setOffset(double offset)
               throws java.io.IOException,
                      AutomationException
The offset between the label and the feature.

Specified by:
setOffset in interface ILabelEngineLayerProperties
Specified by:
setOffset in interface ILabelEngineLayerProperties2
Parameters:
offset - The offset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffset

public double getOffset()
                 throws java.io.IOException,
                        AutomationException
The offset between the label and the feature.

Specified by:
getOffset in interface ILabelEngineLayerProperties
Specified by:
getOffset in interface ILabelEngineLayerProperties2
Returns:
The offset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBasicOverposterLayerPropertiesByRef

public void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
                                            throws java.io.IOException,
                                                   AutomationException
The overposter properties, which specify how labels are placed relative to features.

Specified by:
setBasicOverposterLayerPropertiesByRef in interface ILabelEngineLayerProperties
Specified by:
setBasicOverposterLayerPropertiesByRef in interface ILabelEngineLayerProperties2
Parameters:
props - A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBasicOverposterLayerProperties

public IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
                                                                  throws java.io.IOException,
                                                                         AutomationException
The overposter properties, which specify how labels are placed relative to features.

Specified by:
getBasicOverposterLayerProperties in interface ILabelEngineLayerProperties
Specified by:
getBasicOverposterLayerProperties in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpression

public void setExpression(java.lang.String expression)
                   throws java.io.IOException,
                          AutomationException
The VBScript or JScript expression that evaluates and formats the label.

Specified by:
setExpression in interface ILabelEngineLayerProperties
Specified by:
setExpression in interface ILabelEngineLayerProperties2
Parameters:
expression - The expression (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExpression

public java.lang.String getExpression()
                               throws java.io.IOException,
                                      AutomationException
The VBScript or JScript expression that evaluates and formats the label.

Specified by:
getExpression in interface ILabelEngineLayerProperties
Specified by:
getExpression in interface ILabelEngineLayerProperties2
Returns:
The expression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsExpressionSimple

public void setIsExpressionSimple(boolean simpleExpression)
                           throws java.io.IOException,
                                  AutomationException
Indicates if the expression is simple.

Specified by:
setIsExpressionSimple in interface ILabelEngineLayerProperties
Specified by:
setIsExpressionSimple in interface ILabelEngineLayerProperties2
Parameters:
simpleExpression - The simpleExpression (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

public boolean isExpressionSimple()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the expression is simple.

Specified by:
isExpressionSimple in interface ILabelEngineLayerProperties
Specified by:
isExpressionSimple in interface ILabelEngineLayerProperties2
Returns:
The simpleExpression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpressionParserByRef

public void setExpressionParserByRef(IAnnotationExpressionEngine engine)
                              throws java.io.IOException,
                                     AutomationException
The object that interprets the expression.

Specified by:
setExpressionParserByRef in interface ILabelEngineLayerProperties
Specified by:
setExpressionParserByRef in interface ILabelEngineLayerProperties2
Parameters:
engine - A reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExpressionParser

public IAnnotationExpressionEngine getExpressionParser()
                                                throws java.io.IOException,
                                                       AutomationException
The object that interprets the expression.

Specified by:
getExpressionParser in interface ILabelEngineLayerProperties
Specified by:
getExpressionParser in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationClassID

public void setAnnotationClassID(int annotationClassID)
                          throws java.io.IOException,
                                 AutomationException
The ID of the annotation class.

Specified by:
setAnnotationClassID in interface ILabelEngineLayerProperties2
Parameters:
annotationClassID - The annotationClassID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationClassID

public int getAnnotationClassID()
                         throws java.io.IOException,
                                AutomationException
The ID of the annotation class.

Specified by:
getAnnotationClassID in interface ILabelEngineLayerProperties2
Returns:
The annotationClassID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverposterLayerPropertiesByRef

public void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
                                       throws java.io.IOException,
                                              AutomationException
The overposter properties, which specify how labels are placed relative to features.

Specified by:
setOverposterLayerPropertiesByRef in interface ILabelEngineLayerProperties2
Parameters:
props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverposterLayerProperties

public IOverposterLayerProperties getOverposterLayerProperties()
                                                        throws java.io.IOException,
                                                               AutomationException
The overposter properties, which specify how labels are placed relative to features.

Specified by:
getOverposterLayerProperties in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.carto.IOverposterLayerProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBounds

public void setBounds(IEnvelope bounds)
               throws java.io.IOException,
                      AutomationException
The full extent in world coordinates.

Specified by:
setBounds in interface IAnnotateLayerTransformationProperties
Parameters:
bounds - 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.

getBounds

public IEnvelope getBounds()
                    throws java.io.IOException,
                           AutomationException
The full extent in world coordinates.

Specified by:
getBounds in interface IAnnotateLayerTransformationProperties
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.

getUnits

public int getUnits()
             throws java.io.IOException,
                    AutomationException
The units of the world coordinates.

Specified by:
getUnits in interface IAnnotateLayerTransformationProperties
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnits

public void setUnits(int unitsCode)
              throws java.io.IOException,
                     AutomationException
The units of the world coordinates.

Specified by:
setUnits in interface IAnnotateLayerTransformationProperties
Parameters:
unitsCode - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScaleRatio

public double getScaleRatio()
                     throws java.io.IOException,
                            AutomationException
Scale ratio of the transformation. Based on IAnnotationLayerProperties.Extent and Bounds.

Specified by:
getScaleRatio in interface IAnnotateLayerTransformationProperties
Returns:
The scale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleRatio

public void setScaleRatio(double scale)
                   throws java.io.IOException,
                          AutomationException
Scale ratio of the transformation. Based on IAnnotationLayerProperties.Extent and Bounds.

Specified by:
setScaleRatio in interface IAnnotateLayerTransformationProperties
Parameters:
scale - The scale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException
Reference scale for computing scaled symbol sizes.

Specified by:
getReferenceScale in interface IAnnotateLayerTransformationProperties
Returns:
The scale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double scale)
                       throws java.io.IOException,
                              AutomationException
Reference scale for computing scaled symbol sizes.

Specified by:
setReferenceScale in interface IAnnotateLayerTransformationProperties
Parameters:
scale - The scale (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

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

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
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - 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.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

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
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException
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
Assigns the properties of src to the receiver.

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException
Indicates if 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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException
Indicates if 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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException