com.esri.arcgis.carto
Class MaplexKeyNumberGroup

java.lang.Object
  com.esri.arcgis.carto.MaplexKeyNumberGroup

All Implemented Interfaces:

IMaplexKeyNumberGroup, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MaplexKeyNumberGroup
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IMaplexKeyNumberGroup, IPersistStream, IClone, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'A Maplex key number group.' 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.IMaplexKeyNumberGroup

IID, IIDae54019f_8f5e_6742_88f5_663fe3e3dba5, 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

MaplexKeyNumberGroup()
Constructs a MaplexKeyNumberGroup using ArcGIS Engine.

MaplexKeyNumberGroup(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexKeyNumberGroup theMaplexKeyNumberGroup = (MaplexKeyNumberGroup) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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.
java.lang.String	getDelimiterCharacter() The delimiter character used by the key numbering group.
int	getHorizontalAlignment() The horizontal alignment used by the key numbering group.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getMaximumNumberOfLines() The maximum number of lines allowed in the key numbering group.
int	getMinimumNumberOfLines() The minimum number of lines allowed in the key numbering group.
java.lang.String	getName() The name of the key numbering group.
int	getNumberResetType() The type of number reset used by the key numbering group.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a MaplexKeyNumberGroup.
void	save(IStream pstm, int fClearDirty) save
void	setDelimiterCharacter(java.lang.String name) The delimiter character used by the key numbering group.
void	setHorizontalAlignment(int value) The horizontal alignment used by the key numbering group.
void	setMaximumNumberOfLines(int value) The maximum number of lines allowed in the key numbering group.
void	setMinimumNumberOfLines(int value) The minimum number of lines allowed in the key numbering group.
void	setName(java.lang.String name) The name of the key numbering group.
void	setNumberResetType(int value) The type of number reset used by the key numbering group.
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

MaplexKeyNumberGroup

public MaplexKeyNumberGroup()
                     throws java.io.IOException,
                            java.net.UnknownHostException

Constructs a MaplexKeyNumberGroup using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MaplexKeyNumberGroup

public MaplexKeyNumberGroup(java.lang.Object obj)
                     throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexKeyNumberGroup theMaplexKeyNumberGroup = (MaplexKeyNumberGroup) obj;

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

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

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the key numbering group.

Specified by:

getName in interface IMaplexKeyNumberGroup

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the key numbering group.

Specified by:

setName in interface IMaplexKeyNumberGroup

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHorizontalAlignment

public int getHorizontalAlignment()
                           throws java.io.IOException,
                                  AutomationException

The horizontal alignment used by the key numbering group.

Specified by:

getHorizontalAlignment in interface IMaplexKeyNumberGroup

Returns:

A com.esri.arcgis.carto.esriMaplexKeyNumberHorizontalAlignment constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHorizontalAlignment

public void setHorizontalAlignment(int value)
                            throws java.io.IOException,
                                   AutomationException

The horizontal alignment used by the key numbering group.

Specified by:

setHorizontalAlignment in interface IMaplexKeyNumberGroup

Parameters:

value - A com.esri.arcgis.carto.esriMaplexKeyNumberHorizontalAlignment constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumNumberOfLines

public int getMinimumNumberOfLines()
                            throws java.io.IOException,
                                   AutomationException

The minimum number of lines allowed in the key numbering group.

Specified by:

getMinimumNumberOfLines in interface IMaplexKeyNumberGroup

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinimumNumberOfLines

public void setMinimumNumberOfLines(int value)
                             throws java.io.IOException,
                                    AutomationException

The minimum number of lines allowed in the key numbering group.

Specified by:

setMinimumNumberOfLines in interface IMaplexKeyNumberGroup

Parameters:

value - The value (in)

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

The maximum number of lines allowed in the key numbering group.

Specified by:

getMaximumNumberOfLines in interface IMaplexKeyNumberGroup

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumNumberOfLines

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

The maximum number of lines allowed in the key numbering group.

Specified by:

setMaximumNumberOfLines in interface IMaplexKeyNumberGroup

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDelimiterCharacter

public java.lang.String getDelimiterCharacter()
                                       throws java.io.IOException,
                                              AutomationException

The delimiter character used by the key numbering group.

Specified by:

getDelimiterCharacter in interface IMaplexKeyNumberGroup

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDelimiterCharacter

public void setDelimiterCharacter(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException

The delimiter character used by the key numbering group.

Specified by:

setDelimiterCharacter in interface IMaplexKeyNumberGroup

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberResetType

public int getNumberResetType()
                       throws java.io.IOException,
                              AutomationException

The type of number reset used by the key numbering group.

Specified by:

getNumberResetType in interface IMaplexKeyNumberGroup

Returns:

A com.esri.arcgis.carto.esriMaplexKeyNumberResetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberResetType

public void setNumberResetType(int value)
                        throws java.io.IOException,
                               AutomationException

The type of number reset used by the key numbering group.

Specified by:

setNumberResetType in interface IMaplexKeyNumberGroup

Parameters:

value - A com.esri.arcgis.carto.esriMaplexKeyNumberResetType constant (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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

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