com.esri.arcgis.controls
Class IARConfigurationProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.controls.IARConfigurationProxy
All Implemented Interfaces:
IARConfiguration, Externalizable, Serializable

public class IARConfigurationProxy
extends com.esri.arcgis.interop.Dispatch
implements IARConfiguration, Serializable

Provides access to members that control the ARConfiguration.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IARConfigurationProxy()
           
  IARConfigurationProxy(Object obj)
           
protected IARConfigurationProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 Object getCustomProperty()
          A property to associate data with an object.
 Object getSetting(String sName)
          The configuration setting specified.
 String getTemplateFile()
          The file name of the configuration file loaded into the control.
 boolean isBoolSetting(String sName)
          The configuration setting specified, whose value is a boolean.
 void load(String sFilename)
          Loads each configuration setting from the specified file into the control.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void save(String sFilename)
          Saves each of the control's current configuration settings into the specified file.
 void setBoolSetting(String sName, boolean pVal)
          The configuration setting specified, whose value is a boolean.
 void setCustomProperty(Object pVal)
          A property to associate data with an object.
 void setDefaults()
          Set each control configuration setting to its default value.
 void setSetting(String sName, Object pVal)
          The configuration setting specified.
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IARConfigurationProxy

public IARConfigurationProxy()

IARConfigurationProxy

public IARConfigurationProxy(Object obj)
                      throws IOException
Throws:
IOException

IARConfigurationProxy

protected IARConfigurationProxy(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

setDefaults

public void setDefaults()
                 throws IOException,
                        AutomationException
Set each control configuration setting to its default value.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

load

public void load(String sFilename)
          throws IOException,
                 AutomationException
Loads each configuration setting from the specified file into the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

save

public void save(String sFilename)
          throws IOException,
                 AutomationException
Saves each of the control's current configuration settings into the specified file.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

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

getTemplateFile

public String getTemplateFile()
                       throws IOException,
                              AutomationException
The file name of the configuration file loaded into the control. An empty string is returned is the control is using default configuration settings.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getTemplateFile in interface IARConfiguration
Returns:
The sFilename
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSetting

public Object getSetting(String sName)
                  throws IOException,
                         AutomationException
The configuration setting specified.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getSetting in interface IARConfiguration
Parameters:
sName - The sName (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSetting

public void setSetting(String sName,
                       Object pVal)
                throws IOException,
                       AutomationException
The configuration setting specified.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setSetting in interface IARConfiguration
Parameters:
sName - The sName (in)
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBoolSetting

public boolean isBoolSetting(String sName)
                      throws IOException,
                             AutomationException
The configuration setting specified, whose value is a boolean.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
isBoolSetting in interface IARConfiguration
Parameters:
sName - The sName (in)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBoolSetting

public void setBoolSetting(String sName,
                           boolean pVal)
                    throws IOException,
                           AutomationException
The configuration setting specified, whose value is a boolean.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setBoolSetting in interface IARConfiguration
Parameters:
sName - The sName (in)
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getCustomProperty in interface IARConfiguration
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setCustomProperty in interface IARConfiguration
Parameters:
pVal - A Variant (in)
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
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException