com.esri.arcgis.globecore
Class IKmlNodeProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.globecore.IKmlNodeProxy

All Implemented Interfaces:

IKmlNode, Externalizable, Serializable

public class IKmlNodeProxy
extends com.esri.arcgis.interop.Dispatch
implements IKmlNode, Serializable

Properties of a of KML Node.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getDescription() Kml Node description.
String	getName() Kml Node name.
String	getSnippet() Kml Node Snippet.
boolean	isHasDescription() Does Kml Node have a description.
boolean	isHasName() Does Kml Node have a name.
boolean	isHasSnippet() Does Kml Node have a snippet.
boolean	isVisible() Is the Kml node is visible.
void	removeListener(String iidStr, Object theListener)
void	setVisible(boolean visible) Is the Kml node is visible.

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

IKmlNodeProxy

public IKmlNodeProxy()

IKmlNodeProxy

public IKmlNodeProxy(Object obj)
              throws IOException

Throws:

IOException

IKmlNodeProxy

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

getName

public String getName()
               throws IOException,
                      AutomationException

Kml Node name.

Description

This property returns the name of the KML Node as a string

Product Availability

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

Specified by:

getName in interface IKmlNode

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnippet

public String getSnippet()
                  throws IOException,
                         AutomationException

Kml Node Snippet.

Description

Snippet is a smaller description of the KML Node. This property returns the Snippet of the KML Node as a string

Product Availability

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

Specified by:

getSnippet in interface IKmlNode

Returns:

The snippet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Kml Node description.

Description

This property would return any description (plain text or HTML) in the KML file. In a KML file the "<Description>" tag is used to store descriptive information.

Product Availability

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

Specified by:

getDescription in interface IKmlNode

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Is the Kml node is visible.

Description

This property returns a boolean value (true/false) indicating if the Node is visible or not.

If the visibility of a Node is changed it should be followed by a call to IKmlLayer.RefreshVisibleNodes in order for the change to be reflected on the display. Please see help for IKmlLayer.RefreshVisibleNodes for more information.

Product Availability

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

Specified by:

isVisible in interface IKmlNode

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Is the Kml node is visible.

Description

Use this property to set the visibility of the Node. The property takes in a boolean (true/false) as an argument.

If the visibility of a Node is changed it should be followed by a call to IKmlLayer.RefreshVisibleNodes in order for the change to be reflected on the display. Please see help for IKmlLayer.RefreshVisibleNodes for more information.

Product Availability

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

Specified by:

setVisible in interface IKmlNode

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasName

public boolean isHasName()
                  throws IOException,
                         AutomationException

Does Kml Node have a name.

Description

This property returns a boolean value (true/false) indicating if the Node has a Name or not.

Product Availability

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

Specified by:

isHasName in interface IKmlNode

Returns:

The pHasName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasSnippet

public boolean isHasSnippet()
                     throws IOException,
                            AutomationException

Does Kml Node have a snippet.

Description

This property returns a boolean value (true/false) indicating if the Node has a Snippet or not.

Product Availability

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

Specified by:

isHasSnippet in interface IKmlNode

Returns:

The pHasSnippet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasDescription

public boolean isHasDescription()
                         throws IOException,
                                AutomationException

Does Kml Node have a description.

Description

This property returns a boolean value (true/false) indicating if the Node has a Description or not.

Product Availability

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

Specified by:

isHasDescription in interface IKmlNode

Returns:

The pHasDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.