com.esri.arcgis.cartoUI
Class NetworkDirtyAreaRendererPropertyPage

java.lang.Object
  extended by com.esri.arcgis.cartoUI.NetworkDirtyAreaRendererPropertyPage
All Implemented Interfaces:
INetworkRendererPropertyPage, IPropertyPage, IPropertyPageContext, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NetworkDirtyAreaRendererPropertyPage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPropertyPage, IPropertyPageContext, INetworkRendererPropertyPage

Property page for managing the properties of the NetworkDirtyAreaRenderer object.

Product Availability

Available with ArcGIS Desktop.

See Also:
Serialized Form

Constructor Summary
NetworkDirtyAreaRendererPropertyPage(Object obj)
          Construct a NetworkDirtyAreaRendererPropertyPage using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void activate(_RemotableHandle hWndParent, tagRECT pRect, int bModal)
          activate
 boolean applies(Object unkArray)
          Check if property page applies to the specified set of objects.
 void apply()
          apply
 void cancel()
          Property sheet calls this when cancel button is pressed.
 void canEdit(INetworkRenderer obj, boolean[] result)
          Indicates if the network renderer can be edited by the property page.
 Object createCompatibleObject(Object kind)
          Create a new object using the specified object as a template.
 void deactivate()
          deactivate
 boolean equals(Object o)
          Compare this object with another
 String getCategory()
          Category for the renderer property page.
 IUID getClassID()
          Property page class id (unique identifier object).
 String getDescription()
          Description of the renderer.
 String getHelpFile(int controlID)
          Returns the help file name for the specified control.
 int getHelpId(int controlID)
          Returns the help ID for the specified control.
 String getName(int rendererType)
          Renderer name for the specified renderer type.
 void getPageInfo(tagPROPPAGEINFO[] pPageInfo)
          getPageInfo
 int getPreviewImage()
          Preview bitmap for the renderer that appears on the page.
 int getPriority()
          The page's priority relative to other pages that interact with the same object.
 IUID getRendererClassID()
          Renderer class id (unique identifier object).
 int hashCode()
          the hashcode for this object
 void help(String pszHelpDir)
          help
 boolean isAppliesTo(int rendererType)
          Indicates if the property page is applicable to the specified renderer type.
 void isPageDirty()
          isPageDirty
 void move(tagRECT pRect)
          move
 void queryObject(Object theObject)
          Apply the property page settings to the specified object.
 void setObjects(int cObjects, Object[] ppUnk)
          setObjects
 void setPageSite(IPropertyPageSite pPageSite)
          setPageSite
 void show(int nCmdShow)
          show
 void translateAccelerator(tagMSG pMsg)
          translateAccelerator
 
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

NetworkDirtyAreaRendererPropertyPage

public NetworkDirtyAreaRendererPropertyPage(Object obj)
                                     throws IOException
Construct a NetworkDirtyAreaRendererPropertyPage using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NetworkDirtyAreaRendererPropertyPage.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NetworkDirtyAreaRendererPropertyPage o = (NetworkDirtyAreaRendererPropertyPage)obj; // will not work

NetworkDirtyAreaRendererPropertyPage o = new NetworkDirtyAreaRendererPropertyPage(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems NetworkDirtyAreaRendererPropertyPage theNetworkDirtyAreaRendererPropertyPage = (NetworkDirtyAreaRendererPropertyPage) obj;
Method Detail

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

setPageSite

public void setPageSite(IPropertyPageSite pPageSite)
                 throws IOException,
                        AutomationException
setPageSite

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setPageSite in interface IPropertyPage
Parameters:
pPageSite - A reference to a com.esri.arcgis.framework.IPropertyPageSite (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

activate

public void activate(_RemotableHandle hWndParent,
                     tagRECT pRect,
                     int bModal)
              throws IOException,
                     AutomationException
activate

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
activate in interface IPropertyPage
Parameters:
hWndParent - A Structure: com.esri.arcgis.framework._RemotableHandle (A com.esri.arcgis.framework._RemotableHandle COM typedef) (in)
pRect - A Structure: com.esri.arcgis.system.tagRECT (in)
bModal - The bModal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException
deactivate

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

getPageInfo

public void getPageInfo(tagPROPPAGEINFO[] pPageInfo)
                 throws IOException,
                        AutomationException
getPageInfo

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getPageInfo in interface IPropertyPage
Parameters:
pPageInfo - A Structure: com.esri.arcgis.framework.tagPROPPAGEINFO (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjects

public void setObjects(int cObjects,
                       Object[] ppUnk)
                throws IOException,
                       AutomationException
setObjects

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setObjects in interface IPropertyPage
Parameters:
cObjects - The cObjects (in)
ppUnk - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

show

public void show(int nCmdShow)
          throws IOException,
                 AutomationException
show

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

move

public void move(tagRECT pRect)
          throws IOException,
                 AutomationException
move

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
move in interface IPropertyPage
Parameters:
pRect - A Structure: com.esri.arcgis.system.tagRECT (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPageDirty

public void isPageDirty()
                 throws IOException,
                        AutomationException
isPageDirty

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

apply

public void apply()
           throws IOException,
                  AutomationException
apply

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

help

public void help(String pszHelpDir)
          throws IOException,
                 AutomationException
help

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
help in interface IPropertyPage
Parameters:
pszHelpDir - A String (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

translateAccelerator

public void translateAccelerator(tagMSG pMsg)
                          throws IOException,
                                 AutomationException
translateAccelerator

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
translateAccelerator in interface IPropertyPage
Parameters:
pMsg - A Structure: com.esri.arcgis.framework.tagMSG (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws IOException,
                       AutomationException
The page's priority relative to other pages that interact with the same object. The higher the value, the higher the priority.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getPriority in interface IPropertyPageContext
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object unkArray)
                throws IOException,
                       AutomationException
Check if property page applies to the specified set of objects. Signature corresponds to IPropertyPage::SetObjects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

createCompatibleObject

public Object createCompatibleObject(Object kind)
                              throws IOException,
                                     AutomationException
Create a new object using the specified object as a template. The kind argument may be NULL if the page interacts with only a single object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
createCompatibleObject in interface IPropertyPageContext
Parameters:
kind - A Variant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryObject

public void queryObject(Object theObject)
                 throws IOException,
                        AutomationException
Apply the property page settings to the specified object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
queryObject in interface IPropertyPageContext
Parameters:
theObject - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile(int controlID)
                   throws IOException,
                          AutomationException
Returns the help file name for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getHelpFile in interface IPropertyPageContext
Parameters:
controlID - The controlID (in)
Returns:
The helpFile
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHelpId

public int getHelpId(int controlID)
              throws IOException,
                     AutomationException
Returns the help ID for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getHelpId in interface IPropertyPageContext
Parameters:
controlID - The controlID (in)
Returns:
The helpID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws IOException,
                   AutomationException
Property sheet calls this when cancel button is pressed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
Description of the renderer.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getDescription in interface INetworkRendererPropertyPage
Returns:
The desc
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName(int rendererType)
               throws IOException,
                      AutomationException
Renderer name for the specified renderer type.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getName in interface INetworkRendererPropertyPage
Parameters:
rendererType - A com.esri.arcgis.carto.esriNetworkRendererType constant (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
Category for the renderer property page.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getCategory in interface INetworkRendererPropertyPage
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAppliesTo

public boolean isAppliesTo(int rendererType)
                    throws IOException,
                           AutomationException
Indicates if the property page is applicable to the specified renderer type.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isAppliesTo in interface INetworkRendererPropertyPage
Parameters:
rendererType - A com.esri.arcgis.carto.esriNetworkRendererType constant (in)
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPreviewImage

public int getPreviewImage()
                    throws IOException,
                           AutomationException
Preview bitmap for the renderer that appears on the page.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getPreviewImage in interface INetworkRendererPropertyPage
Returns:
The hBitmap (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRendererClassID

public IUID getRendererClassID()
                        throws IOException,
                               AutomationException
Renderer class id (unique identifier object).

Product Availability

Available with ArcGIS Desktop.

Specified by:
getRendererClassID in interface INetworkRendererPropertyPage
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException
Property page class id (unique identifier object).

Product Availability

Available with ArcGIS Desktop.

Specified by:
getClassID in interface INetworkRendererPropertyPage
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canEdit

public void canEdit(INetworkRenderer obj,
                    boolean[] result)
             throws IOException,
                    AutomationException
Indicates if the network renderer can be edited by the property page.

Product Availability

Available with ArcGIS Desktop.

Specified by:
canEdit in interface INetworkRendererPropertyPage
Parameters:
obj - A reference to a com.esri.arcgis.carto.INetworkRenderer (in)
result - The result (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.