com.esri.arcgis.carto
Interface IMaplexLabelStackingProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IMaplexLabelStackingPropertiesProxy, MaplexLabelStackingProperties

public interface IMaplexLabelStackingProperties
extends java.io.Serializable

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

Description: 'Provides access to members that control the placement of stacked labels.' 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	IID20664808_3a22_12a1_fa09_0a56ff3c731a
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addSeparator(java.lang.String separator, boolean visible, boolean splitForced, boolean splitAfter) Adds the specified separator to the collection.
void	clearSeparators() Removes all the separators in the collection.
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.
int	getStackJustification() Justification options for label stacking.
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	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.

Field Detail

IID20664808_3a22_12a1_fa09_0a56ff3c731a

static final int IID20664808_3a22_12a1_fa09_0a56ff3c731a

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

getStackJustification

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

Justification options for label stacking.

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

void setStackJustification(int option)
                           throws java.io.IOException,
                                  AutomationException

Justification options for label stacking.

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

void addSeparator(java.lang.String separator,
                  boolean visible,
                  boolean splitForced,
                  boolean splitAfter)
                  throws java.io.IOException,
                         AutomationException

Adds the specified separator to the collection.

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

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

The number of separator in the collection.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

querySeparator

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.

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

void clearSeparators()
                     throws java.io.IOException,
                            AutomationException

Removes all the separators in the collection.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumNumberOfLines

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

Maximum number of lines on which the label may be stacked.

Returns:

The limit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumNumberOfLines

void setMaximumNumberOfLines(int limit)
                             throws java.io.IOException,
                                    AutomationException

Maximum number of lines on which the label may be stacked.

Parameters:

limit - The limit (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumNumberOfCharsPerLine

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

Minimum number of characters required on each line.

Returns:

The limit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumNumberOfCharsPerLine

void setMinimumNumberOfCharsPerLine(int limit)
                                    throws java.io.IOException,
                                           AutomationException

Minimum number of characters required on each line.

Parameters:

limit - The limit (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumNumberOfCharsPerLine

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

Maximum number of characters allowed on a line.

Returns:

The limit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumNumberOfCharsPerLine

void setMaximumNumberOfCharsPerLine(int limit)
                                    throws java.io.IOException,
                                           AutomationException

Maximum number of characters allowed on a line.

Parameters:

limit - The limit (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.