com.esri.arcgis.geodatabaseui
Class TableView

java.lang.Object
  extended by com.esri.arcgis.geodatabaseui.TableView
All Implemented Interfaces:
ITableControl, ITableControl2, ITableControl3, ITableControlInfo, ITableControlWidth, ITableView, ITableView2, ITableView3, ITableView4, ITableViewOutput, ITableViewTableFields, com.esri.arcgis.interop.RemoteObjRef, IClone, Serializable

public class TableView
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITableView, ITableView2, ITableView3, ITableView4, ITableViewOutput, ITableControl, ITableControl2, ITableControl3, ITableControlWidth, ITableControlInfo, ITableViewTableFields, IClone

Window to display Tables.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
TableView()
          Constructs a TableView using ArcGIS Engine.
TableView(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TableView theTableView = (TableView) obj;
 
Method Summary
 void addITableViewEventsListener(ITableViewEvents theListener)
          addITableViewEventsListener.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void drawSelectedShapes(IDisplay pDisplay)
          Draws selected features on display.
 void editChanged()
          Call after start or stop editing, to update table grid.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void executeOptionCommand(int option)
          Executes a command in the option menu.
static String getClsid()
          getClsid.
 int getCurrentCol()
          The current col (FDO field index) the user is on.
 int getCurrentRow(boolean isOid)
          The current row the user is on.
 int getFullTableWidth()
          Table width of all columns, and scroll bars.
 int getLeftCol()
          Gets the left visible column of the view window.
 int getRecommendMinimumTableWidth()
          Recommend minimum table width, that will ensure all controls can be seen.
 int getRecordCount()
          Number of records read.
 ISelectionSet getSelectionSet()
          Selection set of records to show/select.
 ITable getTable()
          Table to view/edit.
 ITableFields getTableFields()
          The collection of field information for the table being viewed/edited.
 int getTopRow()
          Gets the top visible row of the view window.
 int hashCode()
          the hashcode for this object
 void insertNextRowAt(int placement, int oid)
          Determines where the next insert record is inserted when OnCreate is fired.
 boolean isAllowEditing()
          Editing allowed on the table.
 boolean isAreAllRecordsRead()
          Indicates whether all records have been read by the table window.
 boolean isEditing()
          Indicates whether the table window is in an editing session.
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isMetafileDirty()
          Indicates whether the metafile needs to be re-generated next time when Output is called.
 boolean isShowAliasNamesInColumnHeadings()
          Show alias names or the real field name in column headings.
 boolean isShowSelected()
          Show only features that are selected.
 int output(int hDC, int dpi, int left, int top, int width, int height, int startRow, int startCol)
          Draw the table to the specified device context, and return windows enhanced metafile.
 void readToEndOfTable()
          Read all the OIDs/Rows in the table.
 void redraw()
          Redraws the grid.
 void removeAndReloadCache()
          Lose cache, so the table window is current with the underlying database.
 void removeITableViewEventsListener(ITableViewEvents theListener)
          removeITableViewEventsListener.
 void rereadFIDs(ISelectionSet pSelection)
          ReReads rows.
 void setAllowAddRow(boolean rhs1)
          Allow add row to be displayed during editing.
 void setAllowDeleteRow(boolean rhs1)
          Allow delete row during editing.
 void setAllowEditing(boolean rhs1)
          Allow editing.
 void setCallbackByRef(ITableViewCallback rhs1)
          The call back routine.
 void setCellFont(int oid, String fieldName, IColor pCellColor, IFont pTextFont, IColor pTextColor)
          Overrides the font setting for table cells.
 void setCurrentRow(boolean isOid, int rowNumber)
          The current row the user is on.
 void setHideOptionsButton(boolean rhs1)
          Hides the options button.
 void setHideViewToggleButtons(boolean rhs1)
          Hides the view toggle buttons.
 void setIsMetafileDirty(boolean pIsDirty)
          Indicates whether the metafile needs to be re-generated next time when Output is called.
 void setPosition(int left, int top, int width, int height)
          Sets the position of the view window.
 void setQueryFilterByRef(IQueryFilter rhs1)
          QueryFilter of records to show.
 void setSelectionSetByRef(ISelectionSet ppSelection)
          Selection set of records to show/select.
 void setSelectToggleAlwaysEnabled(boolean rhs1)
          Ensures that the Select button is always active of the view toggle buttons.
 void setShowAliasNamesInColumnHeadings(boolean rhs1)
          Show alias names or the real field name in column headings.
 void setShowSelected(boolean rhs1)
          Show only features that are selected.
 void setTableByRef(ITable rhs1)
          Table to view/edit.
 void setTableFieldsByRef(ITableFields tableFields)
          The collection of field information for the table being viewed/edited.
 void setTableSelectionAction(int rhs1)
          Action to perform when table selections are made.
 void show(int parentHWnd, tagRECT initialExtent, boolean initiallyVisible)
          Show table.
 void updateSelection(ISelectionSet pSelection)
          Updates the current selection, that the current selection is currently pointing to.
 
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

TableView

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

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

TableView

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

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

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

addITableViewEventsListener

public void addITableViewEventsListener(ITableViewEvents theListener)
                                 throws IOException
addITableViewEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabaseui.ITableViewEvents interface.
Throws:
IOException - If there are communications problems.

removeITableViewEventsListener

public void removeITableViewEventsListener(ITableViewEvents theListener)
                                    throws IOException
removeITableViewEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabaseui.ITableViewEvents interface.
Throws:
IOException - If there are communications problems.

setTableByRef

public void setTableByRef(ITable rhs1)
                   throws IOException,
                          AutomationException
Table to view/edit.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setTableByRef in interface ITableView
Specified by:
setTableByRef in interface ITableView2
Specified by:
setTableByRef in interface ITableView3
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter rhs1)
                         throws IOException,
                                AutomationException
QueryFilter of records to show.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setQueryFilterByRef in interface ITableView
Specified by:
setQueryFilterByRef in interface ITableView2
Specified by:
setQueryFilterByRef in interface ITableView3
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelection)
                          throws IOException,
                                 AutomationException
Selection set of records to show/select.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setSelectionSetByRef in interface ITableView
Specified by:
setSelectionSetByRef in interface ITableView2
Specified by:
setSelectionSetByRef in interface ITableView3
Parameters:
ppSelection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException
Selection set of records to show/select.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getSelectionSet in interface ITableView
Specified by:
getSelectionSet in interface ITableView2
Specified by:
getSelectionSet in interface ITableView3
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableSelectionAction

public void setTableSelectionAction(int rhs1)
                             throws IOException,
                                    AutomationException
Action to perform when table selections are made.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setTableSelectionAction in interface ITableView
Specified by:
setTableSelectionAction in interface ITableView2
Specified by:
setTableSelectionAction in interface ITableView3
Parameters:
rhs1 - A com.esri.arcgis.geodatabaseui.esriTableSelectionActions constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowSelected

public void setShowSelected(boolean rhs1)
                     throws IOException,
                            AutomationException
Show only features that are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setShowSelected in interface ITableView
Specified by:
setShowSelected in interface ITableView2
Specified by:
setShowSelected in interface ITableView3
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowAliasNamesInColumnHeadings

public void setShowAliasNamesInColumnHeadings(boolean rhs1)
                                       throws IOException,
                                              AutomationException
Show alias names or the real field name in column headings. Default False.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setShowAliasNamesInColumnHeadings in interface ITableView
Specified by:
setShowAliasNamesInColumnHeadings in interface ITableView2
Specified by:
setShowAliasNamesInColumnHeadings in interface ITableView3
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCallbackByRef

public void setCallbackByRef(ITableViewCallback rhs1)
                      throws IOException,
                             AutomationException
The call back routine.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setCallbackByRef in interface ITableView
Specified by:
setCallbackByRef in interface ITableView2
Specified by:
setCallbackByRef in interface ITableView3
Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabaseui.ITableViewCallback (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

show

public void show(int parentHWnd,
                 tagRECT initialExtent,
                 boolean initiallyVisible)
          throws IOException,
                 AutomationException
Show table.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
show in interface ITableView
Specified by:
show in interface ITableView2
Specified by:
show in interface ITableView3
Parameters:
parentHWnd - The parentHWnd (A COM typedef) (in)
initialExtent - A Structure: com.esri.arcgis.system.tagRECT (in)
initiallyVisible - The initiallyVisible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws IOException,
                       AutomationException
Table to view/edit.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getTable in interface ITableView2
Specified by:
getTable in interface ITableView3
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowSelected

public boolean isShowSelected()
                       throws IOException,
                              AutomationException
Show only features that are selected.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isShowSelected in interface ITableView2
Specified by:
isShowSelected in interface ITableView3
Returns:
The pShowSelected
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowAliasNamesInColumnHeadings

public boolean isShowAliasNamesInColumnHeadings()
                                         throws IOException,
                                                AutomationException
Show alias names or the real field name in column headings. Default False.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isShowAliasNamesInColumnHeadings in interface ITableView2
Specified by:
isShowAliasNamesInColumnHeadings in interface ITableView3
Returns:
The pShowAliases
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowEditing

public void setAllowEditing(boolean rhs1)
                     throws IOException,
                            AutomationException
Allow editing. Default: True.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setAllowEditing in interface ITableView2
Specified by:
setAllowEditing in interface ITableView3
Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowAddRow

public void setAllowAddRow(boolean rhs1)
                    throws IOException,
                           AutomationException
Allow add row to be displayed during editing. Default: True.

Product Availability

Available with ArcGIS Desktop.

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

setAllowDeleteRow

public void setAllowDeleteRow(boolean rhs1)
                       throws IOException,
                              AutomationException
Allow delete row during editing. Default: True.

Product Availability

Available with ArcGIS Desktop.

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

isAllowEditing

public boolean isAllowEditing()
                       throws IOException,
                              AutomationException
Editing allowed on the table.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isAllowEditing in interface ITableView4
Returns:
The pAllowEditing
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(int left,
                        int top,
                        int width,
                        int height)
                 throws IOException,
                        AutomationException
Sets the position of the view window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setPosition in interface ITableViewOutput
Parameters:
left - The left (in)
top - The top (in)
width - The width (in)
height - The height (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

output

public int output(int hDC,
                  int dpi,
                  int left,
                  int top,
                  int width,
                  int height,
                  int startRow,
                  int startCol)
           throws IOException,
                  AutomationException
Draw the table to the specified device context, and return windows enhanced metafile.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
output in interface ITableViewOutput
Parameters:
hDC - The hDC (A COM typedef) (in)
dpi - The dpi (in)
left - The left (in)
top - The top (in)
width - The width (in)
height - The height (in)
startRow - The startRow (in)
startCol - The startCol (in)
Returns:
The pHEMF (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsMetafileDirty

public void setIsMetafileDirty(boolean pIsDirty)
                        throws IOException,
                               AutomationException
Indicates whether the metafile needs to be re-generated next time when Output is called.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

isMetafileDirty

public boolean isMetafileDirty()
                        throws IOException,
                               AutomationException
Indicates whether the metafile needs to be re-generated next time when Output is called.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isMetafileDirty in interface ITableViewOutput
Returns:
The pIsDirty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

editChanged

public void editChanged()
                 throws IOException,
                        AutomationException
Call after start or stop editing, to update table grid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
editChanged in interface ITableControl
Specified by:
editChanged in interface ITableControl2
Specified by:
editChanged in interface ITableControl3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAndReloadCache

public void removeAndReloadCache()
                          throws IOException,
                                 AutomationException
Lose cache, so the table window is current with the underlying database.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
removeAndReloadCache in interface ITableControl
Specified by:
removeAndReloadCache in interface ITableControl2
Specified by:
removeAndReloadCache in interface ITableControl3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateSelection

public void updateSelection(ISelectionSet pSelection)
                     throws IOException,
                            AutomationException
Updates the current selection, that the current selection is currently pointing to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
updateSelection in interface ITableControl
Specified by:
updateSelection in interface ITableControl2
Specified by:
updateSelection in interface ITableControl3
Parameters:
pSelection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawSelectedShapes

public void drawSelectedShapes(IDisplay pDisplay)
                        throws IOException,
                               AutomationException
Draws selected features on display.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
drawSelectedShapes in interface ITableControl
Specified by:
drawSelectedShapes in interface ITableControl2
Specified by:
drawSelectedShapes in interface ITableControl3
Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rereadFIDs

public void rereadFIDs(ISelectionSet pSelection)
                throws IOException,
                       AutomationException
ReReads rows. Called when viewing selected records and the selection changes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
rereadFIDs in interface ITableControl
Specified by:
rereadFIDs in interface ITableControl2
Specified by:
rereadFIDs in interface ITableControl3
Parameters:
pSelection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentRow

public void setCurrentRow(boolean isOid,
                          int rowNumber)
                   throws IOException,
                          AutomationException
The current row the user is on. If isOid = TRUE, then rowNumber is an OID, else it is an offset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setCurrentRow in interface ITableControl
Specified by:
setCurrentRow in interface ITableControl2
Specified by:
setCurrentRow in interface ITableControl3
Parameters:
isOid - The isOid (in)
rowNumber - The rowNumber (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentRow

public int getCurrentRow(boolean isOid)
                  throws IOException,
                         AutomationException
The current row the user is on. If isOid = TRUE, then rowNumber is an OID, else it is an offset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getCurrentRow in interface ITableControl
Specified by:
getCurrentRow in interface ITableControl2
Specified by:
getCurrentRow in interface ITableControl3
Specified by:
getCurrentRow in interface ITableControlInfo
Parameters:
isOid - The isOid (in)
Returns:
The pRowNumber
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

redraw

public void redraw()
            throws IOException,
                   AutomationException
Redraws the grid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
redraw in interface ITableControl
Specified by:
redraw in interface ITableControl2
Specified by:
redraw in interface ITableControl3
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

readToEndOfTable

public void readToEndOfTable()
                      throws IOException,
                             AutomationException
Read all the OIDs/Rows in the table.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setCellFont

public void setCellFont(int oid,
                        String fieldName,
                        IColor pCellColor,
                        IFont pTextFont,
                        IColor pTextColor)
                 throws IOException,
                        AutomationException
Overrides the font setting for table cells. At least the oid or fieldName must be specified. Enter null fonts to erase.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setCellFont in interface ITableControl3
Parameters:
oid - The oid (in)
fieldName - The fieldName (in)
pCellColor - A reference to a com.esri.arcgis.display.IColor (in)
pTextFont - A reference to a com.esri.arcgis.support.ms.stdole.IFont (in)
pTextColor - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertNextRowAt

public void insertNextRowAt(int placement,
                            int oid)
                     throws IOException,
                            AutomationException
Determines where the next insert record is inserted when OnCreate is fired. Adding records manually via the table window allways adds records to the end of the table.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
insertNextRowAt in interface ITableControl3
Parameters:
placement - A com.esri.arcgis.geodatabaseui.esriTVRowInsertPlacement constant (in)
oid - The oid (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

executeOptionCommand

public void executeOptionCommand(int option)
                          throws IOException,
                                 AutomationException
Executes a command in the option menu.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
executeOptionCommand in interface ITableControl3
Parameters:
option - A com.esri.arcgis.geodatabaseui.esriTableViewOptions constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHideOptionsButton

public void setHideOptionsButton(boolean rhs1)
                          throws IOException,
                                 AutomationException
Hides the options button. Default is False.

Product Availability

Available with ArcGIS Desktop.

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

setSelectToggleAlwaysEnabled

public void setSelectToggleAlwaysEnabled(boolean rhs1)
                                  throws IOException,
                                         AutomationException
Ensures that the Select button is always active of the view toggle buttons. Default is False.

Product Availability

Available with ArcGIS Desktop.

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

setHideViewToggleButtons

public void setHideViewToggleButtons(boolean rhs1)
                              throws IOException,
                                     AutomationException
Hides the view toggle buttons. Default is False.

Product Availability

Available with ArcGIS Desktop.

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

getFullTableWidth

public int getFullTableWidth()
                      throws IOException,
                             AutomationException
Table width of all columns, and scroll bars.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getFullTableWidth in interface ITableControlWidth
Returns:
The pMaxPixels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRecommendMinimumTableWidth

public int getRecommendMinimumTableWidth()
                                  throws IOException,
                                         AutomationException
Recommend minimum table width, that will ensure all controls can be seen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getRecommendMinimumTableWidth in interface ITableControlWidth
Returns:
The pMinPixels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTopRow

public int getTopRow()
              throws IOException,
                     AutomationException
Gets the top visible row of the view window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getTopRow in interface ITableControlInfo
Returns:
The topRow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeftCol

public int getLeftCol()
               throws IOException,
                      AutomationException
Gets the left visible column of the view window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getLeftCol in interface ITableControlInfo
Returns:
The leftCol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRecordCount

public int getRecordCount()
                   throws IOException,
                          AutomationException
Number of records read.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getRecordCount in interface ITableControlInfo
Returns:
The pRecCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAreAllRecordsRead

public boolean isAreAllRecordsRead()
                            throws IOException,
                                   AutomationException
Indicates whether all records have been read by the table window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isAreAllRecordsRead in interface ITableControlInfo
Returns:
The allRecordsRead
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEditing

public boolean isEditing()
                  throws IOException,
                         AutomationException
Indicates whether the table window is in an editing session.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

getCurrentCol

public int getCurrentCol()
                  throws IOException,
                         AutomationException
The current col (FDO field index) the user is on.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getCurrentCol in interface ITableControlInfo
Returns:
The pFDOFieldIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableFieldsByRef

public void setTableFieldsByRef(ITableFields tableFields)
                         throws IOException,
                                AutomationException
The collection of field information for the table being viewed/edited.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setTableFieldsByRef in interface ITableViewTableFields
Parameters:
tableFields - A reference to a com.esri.arcgis.geodatabase.ITableFields (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTableFields

public ITableFields getTableFields()
                            throws IOException,
                                   AutomationException
The collection of field information for the table being viewed/edited.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getTableFields in interface ITableViewTableFields
Returns:
A reference to a com.esri.arcgis.geodatabase.ITableFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

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

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.