com.esri.arcgis.controls
Class ArcReaderConfiguration

java.lang.Object
  extended by com.esri.arcgis.controls.ArcReaderConfiguration
All Implemented Interfaces:
IARConfiguration, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcReaderConfiguration
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARConfiguration

ArcReaderConfiguration contains settings affecting the appearance and behaviour of the control.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Constructor Summary
ArcReaderConfiguration()
          Constructs a ArcReaderConfiguration using ArcGIS Engine.
ArcReaderConfiguration(Object obj)
          Construct a ArcReaderConfiguration using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 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 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.
 
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

ArcReaderConfiguration

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

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

ArcReaderConfiguration

public ArcReaderConfiguration(Object obj)
                       throws IOException
Construct a ArcReaderConfiguration using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcReaderConfiguration.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems ArcReaderConfiguration theArcReaderConfiguration = (ArcReaderConfiguration) obj;
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

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.