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, Externalizable, Serializable

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

Properties that specify the label stacking rules.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MaplexLabelStackingProperties()
          Constructs a MaplexLabelStackingProperties using ArcGIS Engine.
MaplexLabelStackingProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexLabelStackingProperties theMaplexLabelStackingProperties = (MaplexLabelStackingProperties) obj;
 
Method Summary
 void addSeparator(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(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 String getClsid()
          getClsid.
 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)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void querySeparator(int index, String[] separator, boolean[] visible, boolean[] splitForced, boolean[] splitAfter)
          Returns the separator in the collection at the specified index.
 void readExternal(ObjectInput in)
           
 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(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

MaplexLabelStackingProperties

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

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MaplexLabelStackingProperties

public MaplexLabelStackingProperties(Object obj)
                              throws 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:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getStackJustification

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setStackJustification

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

addSeparator

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getSeparatorCount

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

querySeparator

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearSeparators

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getMaximumNumberOfLines

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setMaximumNumberOfLines

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getMinimumNumberOfCharsPerLine

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setMinimumNumberOfCharsPerLine

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getMaximumNumberOfCharsPerLine

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

setMaximumNumberOfCharsPerLine

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

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

readExternal

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