com.esri.arcgis.carto
Class MaplexLabelStackingProperties

java.lang.Object
  extended by com.esri.arcgis.carto.MaplexLabelStackingProperties
All Implemented Interfaces:
IMaplexLabelStackingProperties, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MaplexLabelStackingProperties
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaplexLabelStackingProperties, IPersistStream, IClone, java.io.Externalizable

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

Description 'Properties that specify the label stacking rules.' 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.IMaplexLabelStackingProperties
IID, IID20664808_3a22_12a1_fa09_0a56ff3c731a, 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
MaplexLabelStackingProperties()
          Constructs a MaplexLabelStackingProperties using ArcGIS Engine.
MaplexLabelStackingProperties(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexLabelStackingProperties theMaplexLabelStackingProperties = (MaplexLabelStackingProperties) obj;
 
Method Summary
 void addSeparator(java.lang.String separator, boolean visible, boolean splitForced, boolean splitAfter)
          Adds the specified separator to the collection.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clearSeparators()
          Removes all the separators in the collection.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getMaximumNumberOfCharsPerLine()
          Maximum number of characters allowed on a line.
 int getMaximumNumberOfLines()
          Maximum number of lines on which the label may be stacked.
 int getMinimumNumberOfCharsPerLine()
          Minimum number of characters required on each line.
 int getSeparatorCount()
          The number of separator in the collection.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getStackJustification()
          Justification options for label stacking.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 void load(IStream pstm)
          load
 void querySeparator(int index, java.lang.String[] separator, boolean[] visible, boolean[] splitForced, boolean[] splitAfter)
          Returns the separator in the collection at the specified index.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a MaplexLabelStackingProperties.
 void save(IStream pstm, int fClearDirty)
          save
 void setMaximumNumberOfCharsPerLine(int limit)
          Maximum number of characters allowed on a line.
 void setMaximumNumberOfLines(int limit)
          Maximum number of lines on which the label may be stacked.
 void setMinimumNumberOfCharsPerLine(int limit)
          Minimum number of characters required on each line.
 void setStackJustification(int option)
          Justification options for label stacking.
 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

MaplexLabelStackingProperties

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

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

MaplexLabelStackingProperties

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

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

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

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

getStackJustification

public int getStackJustification()
                          throws java.io.IOException,
                                 AutomationException
Justification options for label stacking.

Specified by:
getStackJustification in interface IMaplexLabelStackingProperties
Returns:
A com.esri.arcgis.carto.esriMaplexStackingJustification constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStackJustification

public void setStackJustification(int option)
                           throws java.io.IOException,
                                  AutomationException
Justification options for label stacking.

Specified by:
setStackJustification in interface IMaplexLabelStackingProperties
Parameters:
option - A com.esri.arcgis.carto.esriMaplexStackingJustification constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSeparator

public void addSeparator(java.lang.String separator,
                         boolean visible,
                         boolean splitForced,
                         boolean splitAfter)
                  throws java.io.IOException,
                         AutomationException
Adds the specified separator to the collection.

Specified by:
addSeparator in interface IMaplexLabelStackingProperties
Parameters:
separator - The separator (in)
visible - The visible (in)
splitForced - The splitForced (in)
splitAfter - The splitAfter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSeparatorCount

public int getSeparatorCount()
                      throws java.io.IOException,
                             AutomationException
The number of separator in the collection.

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

querySeparator

public void querySeparator(int index,
                           java.lang.String[] separator,
                           boolean[] visible,
                           boolean[] splitForced,
                           boolean[] splitAfter)
                    throws java.io.IOException,
                           AutomationException
Returns the separator in the collection at the specified index.

Specified by:
querySeparator in interface IMaplexLabelStackingProperties
Parameters:
index - The index (in)
separator - The separator (out: use single element array)
visible - The visible (out: use single element array)
splitForced - The splitForced (out: use single element array)
splitAfter - The splitAfter (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearSeparators

public void clearSeparators()
                     throws java.io.IOException,
                            AutomationException
Removes all the separators in the collection.

Specified by:
clearSeparators in interface IMaplexLabelStackingProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumNumberOfLines

public int getMaximumNumberOfLines()
                            throws java.io.IOException,
                                   AutomationException
Maximum number of lines on which the label may be stacked.

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

setMaximumNumberOfLines

public void setMaximumNumberOfLines(int limit)
                             throws java.io.IOException,
                                    AutomationException
Maximum number of lines on which the label may be stacked.

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

getMinimumNumberOfCharsPerLine

public int getMinimumNumberOfCharsPerLine()
                                   throws java.io.IOException,
                                          AutomationException
Minimum number of characters required on each line.

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

setMinimumNumberOfCharsPerLine

public void setMinimumNumberOfCharsPerLine(int limit)
                                    throws java.io.IOException,
                                           AutomationException
Minimum number of characters required on each line.

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

getMaximumNumberOfCharsPerLine

public int getMaximumNumberOfCharsPerLine()
                                   throws java.io.IOException,
                                          AutomationException
Maximum number of characters allowed on a line.

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

setMaximumNumberOfCharsPerLine

public void setMaximumNumberOfCharsPerLine(int limit)
                                    throws java.io.IOException,
                                           AutomationException
Maximum number of characters allowed on a line.

Specified by:
setMaximumNumberOfCharsPerLine in interface IMaplexLabelStackingProperties
Parameters:
limit - The limit (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