com.esri.arcgis.analyst3d
Class ControlsSceneSceneToolbar

java.lang.Object
  com.esri.arcgis.analyst3d.ControlsSceneSceneToolbar

All Implemented Interfaces:

IToolBarDef, Serializable

public class ControlsSceneSceneToolbar

extends Object

implements IToolBarDef

A toolbar with common scene control tools.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Description

This toolset works with the ToolbarControl and SceneControl. Its CLSID is: {18A9FFDF-7B77-413A-AF57-81F58BFCFFB3}.

See Also:

Serialized Form

Constructor Summary

ControlsSceneSceneToolbar()
Constructs a ControlsSceneSceneToolbar on the local host.

ControlsSceneSceneToolbar(com.linar.jintegra.AuthInfo authInfo)

ControlsSceneSceneToolbar(Object obj)
Construct a ControlsSceneSceneToolbar using a reference to such an object returned from a COM server

ControlsSceneSceneToolbar(String host)
Construct a ControlsSceneSceneToolbar on specified host.

ControlsSceneSceneToolbar(String host, com.linar.jintegra.AuthInfo authInfo)

Method Summary

static ControlsSceneSceneToolbar	bindUsingMoniker(String moniker) Bind to a running instance of this class using the supplied ObjRef moniker
boolean	equals(Object o) Compare this object with another
static ControlsSceneSceneToolbar	getActiveObject() Get a reference to a running instance of this class on the current machine using native code.
IToolBarDef	getAsIToolBarDef() Access this class's com.esri.arcgis.systemUI.IToolBarDef interface
String	getCaption() The caption of this toolbar.
static String	getClsid()
int	getItemCount() The number of items in this toolbar.
void	getItemInfo(int pos, IItemDef itemDef) The CLSID for the item on this toolbar at the specified index.
String	getName() The name of this toolbar.
Object	getPropertyByName(String name) Get the value of a property dynamically at run-time, based on its name
Object	getPropertyByName(String name, Object rhs) Get the value of a property dynamically at run-time, based on its name and a parameter
int	hashCode() the hashcode for this object
Object	invokeMethodByName(String name, Object[] parameters) Invoke a method dynamically at run-time to pass primitive types (eg Integer to pass an int).

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlsSceneSceneToolbar

public ControlsSceneSceneToolbar()
                          throws IOException,
                                 UnknownHostException

Constructs a ControlsSceneSceneToolbar on the local host.

Throws:

IOException - if there are problems communicating via DCOM

UnknownHostException - if the host can not be found

ControlsSceneSceneToolbar

public ControlsSceneSceneToolbar(String host)
                          throws IOException,
                                 UnknownHostException

Construct a ControlsSceneSceneToolbar on specified host.

Parameters:

host - the host on which the object should be created

Throws:

IOException - if there are problems communicating via DCOM

UnknownHostException - if the host can not be found

ControlsSceneSceneToolbar

public ControlsSceneSceneToolbar(com.linar.jintegra.AuthInfo authInfo)
                          throws IOException,
                                 UnknownHostException

ControlsSceneSceneToolbar

public ControlsSceneSceneToolbar(String host,
                                 com.linar.jintegra.AuthInfo authInfo)
                          throws IOException,
                                 UnknownHostException

ControlsSceneSceneToolbar

public ControlsSceneSceneToolbar(Object obj)
                          throws IOException

Construct a ControlsSceneSceneToolbar using a reference to such an object returned from a COM server

Parameters:

obj - an object returned from a COM server

Throws:

IOException - if there are problems communicating via DCOM

Method Detail

getClsid

public static String getClsid()

getAsIToolBarDef

public IToolBarDef getAsIToolBarDef()

Access this class's com.esri.arcgis.systemUI.IToolBarDef interface

equals

public boolean equals(Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getActiveObject

public static ControlsSceneSceneToolbar getActiveObject()
                                                 throws AutomationException,
                                                        IOException

Get a reference to a running instance of this class on the current machine using native code. Uses native code (See GetActiveObject() in MS doc) and thus can only be used on MS Windows

Returns:

return value. A reference to the running object.

Throws:

IOException - If there are communications problems.

AutomationException - If there was an error attaching to the instance.

bindUsingMoniker

public static ControlsSceneSceneToolbar bindUsingMoniker(String moniker)
                                                  throws AutomationException,
                                                         IOException

Bind to a running instance of this class using the supplied ObjRef moniker

Returns:

return value. A reference to the running object.

Throws:

IOException - If there are communications problems.

AutomationException - If there was an error attaching to the instance.

getPropertyByName

public Object getPropertyByName(String name)
                         throws NoSuchFieldException,
                                IOException,
                                AutomationException

Get the value of a property dynamically at run-time, based on its name

Returns:

return value. The value of the property.

Throws:

NoSuchFieldException - If the property does not exit.

IOException - If there are communications problems.

AutomationException - If the remote server throws an exception.

getPropertyByName

public Object getPropertyByName(String name,
                                Object rhs)
                         throws NoSuchFieldException,
                                IOException,
                                AutomationException

Get the value of a property dynamically at run-time, based on its name and a parameter

Returns:

return value. The value of the property.

Throws:

NoSuchFieldException - If the property does not exit.

IOException - If there are communications problems.

AutomationException - If the remote server throws an exception.

invokeMethodByName

public Object invokeMethodByName(String name,
                                 Object[] parameters)
                          throws NoSuchMethodException,
                                 IOException,
                                 AutomationException

Invoke a method dynamically at run-time to pass primitive types (eg Integer to pass an int).

Returns:

return value. The value returned by the method (null if none).

Throws:

NoSuchMethodException - If the method does not exit.

IOException - If there are communications problems.

AutomationException - If the remote server throws an exception.

getItemCount

public int getItemCount()
                 throws IOException,
                        AutomationException

Description copied from interface: IToolBarDef

The number of items in this toolbar.

Supported Platforms

Windows, Solaris, Linux

Remarks

When implementing IToolBarDef to create a custom toolbar, use the ItemCount property to specify how many items will be on this toolbar.

Specified by:

getItemCount in interface IToolBarDef

Returns:

return value. The numItems

Throws:

IOException - If there are communications problems.

AutomationException - If the remote server throws an exception.

getItemInfo

public void getItemInfo(int pos,
                        IItemDef itemDef)
                 throws IOException,
                        AutomationException

Description copied from interface: IToolBarDef

The CLSID for the item on this toolbar at the specified index.

Supported Platforms

Windows, Solaris, Linux

Description

pos represents the locational index number of this item on the toolbar.

itemDef is an IItemDef object that defines the item at this position of the toolbar.

Remarks

When implementing IToolBarDef to create a custom toolbar, use the GetItemInfo method to define what items are on this toolbar. To find the CLSID, ProgID, and subtype of a built-in command or menu in ArcMap or ArcCatalog, refer to the following technical documents:

ArcObjects Developer Help > Technical Documents > ArcMap: Names and IDs of commands and commandbars

ArcObjects Developer Help > Technical Documents > ArcCatalog: Names and IDs of commands and commandbars

Specified by:

getItemInfo in interface IToolBarDef

Parameters:

pos - The pos (in)

itemDef - An reference to a com.esri.arcgis.systemUI.IItemDef (in)

Throws:

IOException - If there are communications problems.

AutomationException - If the remote server throws an exception.

See Also:

IItemDef

getName

public String getName()
               throws IOException,
                      AutomationException

Description copied from interface: IToolBarDef

The name of this toolbar.

Supported Platforms

Windows, Solaris, Linux

Remarks

When implementing IToolBarDef to create a custom toolbar, use the Name property to set the name of this toolbar.

Specified by:

getName in interface IToolBarDef

Returns:

return value. The name

Throws:

AutomationException - If the remote server throws an exception.

IOException - If there are communications problems.

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException

Description copied from interface: IToolBarDef

The caption of this toolbar.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Caption property of a toolbar is the string that appears as the toolbar title when the toolbar is in a floating state.

When implementing IToolBarDef to create a custom toolbar, use the Caption property to set the caption of this toolbar.

Specified by:

getCaption in interface IToolBarDef

Returns:

return value. The name

Throws:

IOException - If there are communications problems.

AutomationException - If the remote server throws an exception.