com.esri.arcgis.controls
Class ControlsPageLayoutToolbar

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

public class ControlsPageLayoutToolbar
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IToolBarDef

A toolbar with common tools working with pagelayout view.

Description

The CLSID of this toolbar is: {A897C6B7-474B-4BAB-B28E-9418AC01E927}.

This toolbar works with the ToolbarControl, PageLayoutControl and ArcMap.

Product Availability

Available with ArcGIS Engine.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.systemUI.IToolBarDef
IID, IID61b318f0_cda0_11d1_b9a8_080009ee4e51, xxDummy
 
Constructor Summary
ControlsPageLayoutToolbar()
          Constructs a ControlsPageLayoutToolbar using ArcGIS Engine.
ControlsPageLayoutToolbar(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ControlsPageLayoutToolbar theControlsPageLayoutToolbar = (ControlsPageLayoutToolbar) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 String getCaption()
          The caption of this toolbar.
static String getClsid()
          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.
 int hashCode()
          the hashcode for this object
 
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

ControlsPageLayoutToolbar

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

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

ControlsPageLayoutToolbar

public ControlsPageLayoutToolbar(Object obj)
                          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ControlsPageLayoutToolbar theControlsPageLayoutToolbar = (ControlsPageLayoutToolbar) obj;

Construct a ControlsPageLayoutToolbar using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ControlsPageLayoutToolbar.

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

getItemCount

public int getItemCount()
                 throws IOException,
                        AutomationException
The number of items in this toolbar.

Specified by:
getItemCount in interface IToolBarDef
Returns:
The numItems
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfo

public void getItemInfo(int pos,
                        IItemDef itemDef)
                 throws IOException,
                        AutomationException
The CLSID for the item on this toolbar at the specified index.

Specified by:
getItemInfo in interface IToolBarDef
Parameters:
pos - The pos (in)
itemDef - A reference to a com.esri.arcgis.systemUI.IItemDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of this toolbar.

Specified by:
getName in interface IToolBarDef
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCaption

public String getCaption()
                  throws IOException,
                         AutomationException
The caption of this toolbar.

Specified by:
getCaption in interface IToolBarDef
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.