com.esri.arcgis.carto
Class IHotlinkContainerProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IHotlinkContainerProxy

All Implemented Interfaces:

IHotlinkContainer, Externalizable, Serializable

public class IHotlinkContainerProxy
extends com.esri.arcgis.interop.Dispatch
implements IHotlinkContainer, Serializable

Provides access to members that manage all the hotlinks of a layer (e.g. field based hyperlinks or those that that call macros).

Description

Hotlinks are hyperlinks that require a container (i.e. they reside on a layer) because they are either based on a field or they call a macro.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IHotlinkContainerProxy()
	IHotlinkContainerProxy(Object obj)
protected	IHotlinkContainerProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getHotlinkField() Field used for hotlinks.
int	getHotlinkType() Hotlink type.
void	removeListener(String iidStr, Object theListener)
void	setHotlinkField(String fieldName) Field used for hotlinks.
void	setHotlinkType(int linkType) Hotlink type.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IHotlinkContainerProxy

public IHotlinkContainerProxy()

IHotlinkContainerProxy

public IHotlinkContainerProxy(Object obj)
                       throws IOException

Throws:

IOException

IHotlinkContainerProxy

protected IHotlinkContainerProxy(Object obj,
                                 String iid)
                          throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getHotlinkField

public String getHotlinkField()
                       throws IOException,
                              AutomationException

Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHotlinkField in interface IHotlinkContainer

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHotlinkField

public void setHotlinkField(String fieldName)
                     throws IOException,
                            AutomationException

Field used for hotlinks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHotlinkField in interface IHotlinkContainer

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHotlinkType

public int getHotlinkType()
                   throws IOException,
                          AutomationException

Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getHotlinkType in interface IHotlinkContainer

Returns:

A com.esri.arcgis.carto.esriHyperlinkType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHotlinkType

public void setHotlinkType(int linkType)
                    throws IOException,
                           AutomationException

Hotlink type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHotlinkType in interface IHotlinkContainer

Parameters:

linkType - A com.esri.arcgis.carto.esriHyperlinkType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.