org.eclipse.actf.accservice.core.win32.ia2
Class IA2AccessibleTable

java.lang.Object
  extended by org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleElement
      extended by org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleTable
All Implemented Interfaces:
IAccessibleTableElement

public class IA2AccessibleTable
extends IA2AccessibleElement
implements IAccessibleTableElement

implementation of IAccessibleTableElement for GUI controls that implement IAccessible2/IBM interfaces.

This class is a wrapper for an IAccessible2 pointer, a pointer that Provides access to a native Windows object that provides assistive technologies (ATs) with properties of GUI components that allow the AT to offer an alternative interface to the control. This class relies upon JCAccessible.dll for most of its implementation. The documentation for the Microsoft COM library and, in particular, for IAccessible2/IBM will be helpful.

Author:
Mike Smith

Field Summary
 
Fields inherited from class org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleElement
errorCodeReturnMap, errString
 
Constructor Summary
IA2AccessibleTable(int ref, IA2Accessible parent)
          Constructor used to create an accessible table object
 
Method Summary
 Object getCaption()
          get the caption for the table
 IA2Accessible getCell(int row, int column)
           
 int getChildIndex(int rowIndex, int colIndex)
           
 long getColumnCount()
          get the number of columns for the table
 String getColumnDescription(long column)
          get the description for the specified column
 int getColumnExtentAt(int row, int column)
           
 IA2AccessibleTable getColumnHeaders()
           
 int getColumnIndex(int childIndex)
           
 IA2RowColumnExtents getRowColumnExtentsAtIndex(int index)
           
 long getRowCount()
          get the number of rows for the table
 String getRowDescription(long row)
          get the description for the specified row
 int getRowExtentAt(int row, int column)
           
 IA2AccessibleTable getRowHeaders()
           
 int getRowIndex(int childIndex)
           
 int getSelectedAccessibleColumnCount()
           
 int getSelectedAccessibleRowCount()
           
 int getSelectedChildCount()
          get the number of selected chidren for the table
 int[] getSelectedChildren()
          get the indices of the selected Children
 int[] getSelectedColumns()
          get the indecies of the selected columns
 int[] getSelectedRows()
          get the indecies of the selected rows
 Object getSummary()
          get the summary for the table
 IA2AccessibleTableModelChange getTableModelChange()
           
protected  int internalGetCell(int row, int column)
           
protected  String internalGetColumnDescription(long column)
           
protected  int internalGetColumnExtentAt(int row, int column)
           
protected  int internalGetColumnHeaders()
           
protected  int internalGetColumnIndex(int childIndex)
           
protected  int internalGetIndex(int rowIndex, int colIndex)
           
protected  int[] internalGetModelChange()
           
protected  int[] internalGetRowColumnExtentsAtIndex(int index)
           
protected  String internalGetRowDescription(long row)
           
protected  int internalGetRowExtentAt(int row, int column)
           
protected  int internalGetRowHeaders()
           
protected  int internalGetRowIndex(int childIndex)
           
protected  int[] internalGetSelectedAccessibleColumns()
           
protected  int[] internalGetSelectedAccessibleRows()
           
protected  int internalGetSelectedChildCount()
           
protected  int[] internalGetSelectedChildren()
           
protected  int internalGetSelectedColumnCount()
           
protected  int internalGetSelectedRowCount()
           
protected  int internalGetTableCaption()
           
protected  long internalGetTableColumnCount()
           
protected  long internalGetTableRowCount()
           
protected  int internalGetTableSummary()
           
protected  boolean internalIsAccessibleSelected(int row, int column)
           
protected  boolean internalIsColumnSelected(int column)
           
protected  boolean internalIsRowSelected(int row)
           
 int internalRef()
          used by native code only.
protected  boolean internalSelectAccessibleColumn(int column)
           
protected  boolean internalSelectAccessibleRow(int row)
           
protected  boolean internalUnselectAccessibleColumn(int column)
           
protected  boolean internalUnselectAccessibleRow(int row)
           
 boolean isAccessibleColumnSelected(int column)
           
 boolean isAccessibleRowSelected(int row)
           
 boolean isAccessibleSelected(int row, int column)
           
 boolean selectAccessibleColumn(int column)
           
 boolean selectAccessibleRow(int row)
           
 boolean unSelectAccessibleColumn(int column)
           
 boolean unSelectAccessibleRow(int row)
           
 
Methods inherited from class org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleElement
errorCodeMap, putErrorCode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IA2AccessibleTable

public IA2AccessibleTable(int ref,
                          IA2Accessible parent)
Constructor used to create an accessible table object

Parameters:
ref - reference pointer to the IA2Accessible table object
parent - IA2Accessible parent of this object
Method Detail

internalRef

public int internalRef()
used by native code only. Clients should not call directly.

Returns:
ptr address for native object

getCaption

public Object getCaption()
                  throws InvalidComponentException
get the caption for the table

Specified by:
getCaption in interface IAccessibleTableElement
Returns:
caption or an empty string if no caption is provided
Throws:
InvalidComponentException

internalGetTableCaption

protected int internalGetTableCaption()

getSummary

public Object getSummary()
                  throws InvalidComponentException
get the summary for the table

Specified by:
getSummary in interface IAccessibleTableElement
Returns:
summary or an empty string if no summary is provided
Throws:
InvalidComponentException

internalGetTableSummary

protected int internalGetTableSummary()

getColumnCount

public long getColumnCount()
                    throws InvalidComponentException
get the number of columns for the table

Specified by:
getColumnCount in interface IAccessibleTableElement
Returns:
column count
Throws:
InvalidComponentException

internalGetTableColumnCount

protected long internalGetTableColumnCount()

getRowCount

public long getRowCount()
                 throws InvalidComponentException
get the number of rows for the table

Specified by:
getRowCount in interface IAccessibleTableElement
Returns:
row count
Throws:
InvalidComponentException

internalGetTableRowCount

protected long internalGetTableRowCount()

getColumnDescription

public String getColumnDescription(long column)
                            throws InvalidComponentException
get the description for the specified column

Specified by:
getColumnDescription in interface IAccessibleTableElement
Parameters:
column - zero-based index of column
Returns:
row description or an empty string if column index is out of range
Throws:
InvalidComponentException

internalGetColumnDescription

protected String internalGetColumnDescription(long column)

getRowDescription

public String getRowDescription(long row)
                         throws InvalidComponentException
get the description for the specified row

Specified by:
getRowDescription in interface IAccessibleTableElement
Parameters:
row - zero-based index of row
Returns:
row description or an empty string if row index is out of range
Throws:
InvalidComponentException

internalGetRowDescription

protected String internalGetRowDescription(long row)

getSelectedColumns

public int[] getSelectedColumns()
                         throws InvalidComponentException
get the indecies of the selected columns

Specified by:
getSelectedColumns in interface IAccessibleTableElement
Returns:
an array of selected column indecies
Throws:
InvalidComponentException

internalGetSelectedAccessibleColumns

protected int[] internalGetSelectedAccessibleColumns()

getSelectedRows

public int[] getSelectedRows()
                      throws InvalidComponentException
get the indecies of the selected rows

Specified by:
getSelectedRows in interface IAccessibleTableElement
Returns:
an array of selected row indecies
Throws:
InvalidComponentException

internalGetSelectedAccessibleRows

protected int[] internalGetSelectedAccessibleRows()

getCell

public IA2Accessible getCell(int row,
                             int column)
                      throws InvalidComponentException
Throws:
InvalidComponentException

internalGetCell

protected int internalGetCell(int row,
                              int column)

getChildIndex

public int getChildIndex(int rowIndex,
                         int colIndex)
                  throws InvalidComponentException
Throws:
InvalidComponentException

internalGetIndex

protected int internalGetIndex(int rowIndex,
                               int colIndex)

getColumnExtentAt

public int getColumnExtentAt(int row,
                             int column)
                      throws InvalidComponentException
Throws:
InvalidComponentException

internalGetColumnExtentAt

protected int internalGetColumnExtentAt(int row,
                                        int column)

getColumnHeaders

public IA2AccessibleTable getColumnHeaders()
                                    throws InvalidComponentException
Throws:
InvalidComponentException

internalGetColumnHeaders

protected int internalGetColumnHeaders()

getColumnIndex

public int getColumnIndex(int childIndex)
                   throws InvalidComponentException
Throws:
InvalidComponentException

internalGetColumnIndex

protected int internalGetColumnIndex(int childIndex)

getSelectedAccessibleColumnCount

public int getSelectedAccessibleColumnCount()
                                     throws InvalidComponentException
Throws:
InvalidComponentException

internalGetSelectedColumnCount

protected int internalGetSelectedColumnCount()

getSelectedAccessibleRowCount

public int getSelectedAccessibleRowCount()
                                  throws InvalidComponentException
Throws:
InvalidComponentException

internalGetSelectedRowCount

protected int internalGetSelectedRowCount()

getRowExtentAt

public int getRowExtentAt(int row,
                          int column)
                   throws InvalidComponentException
Throws:
InvalidComponentException

internalGetRowExtentAt

protected int internalGetRowExtentAt(int row,
                                     int column)

getRowHeaders

public IA2AccessibleTable getRowHeaders()
                                 throws InvalidComponentException
Throws:
InvalidComponentException

internalGetRowHeaders

protected int internalGetRowHeaders()

getRowIndex

public int getRowIndex(int childIndex)
                throws InvalidComponentException
Throws:
InvalidComponentException

internalGetRowIndex

protected int internalGetRowIndex(int childIndex)

isAccessibleColumnSelected

public boolean isAccessibleColumnSelected(int column)
                                   throws InvalidComponentException
Throws:
InvalidComponentException

internalIsColumnSelected

protected boolean internalIsColumnSelected(int column)

isAccessibleRowSelected

public boolean isAccessibleRowSelected(int row)
                                throws InvalidComponentException
Throws:
InvalidComponentException

internalIsRowSelected

protected boolean internalIsRowSelected(int row)

isAccessibleSelected

public boolean isAccessibleSelected(int row,
                                    int column)
                             throws InvalidComponentException
Throws:
InvalidComponentException

internalIsAccessibleSelected

protected boolean internalIsAccessibleSelected(int row,
                                               int column)

selectAccessibleColumn

public boolean selectAccessibleColumn(int column)
                               throws InvalidComponentException
Throws:
InvalidComponentException

internalSelectAccessibleColumn

protected boolean internalSelectAccessibleColumn(int column)

selectAccessibleRow

public boolean selectAccessibleRow(int row)
                            throws InvalidComponentException
Throws:
InvalidComponentException

internalSelectAccessibleRow

protected boolean internalSelectAccessibleRow(int row)

unSelectAccessibleColumn

public boolean unSelectAccessibleColumn(int column)
                                 throws InvalidComponentException
Throws:
InvalidComponentException

internalUnselectAccessibleColumn

protected boolean internalUnselectAccessibleColumn(int column)

unSelectAccessibleRow

public boolean unSelectAccessibleRow(int row)
                              throws InvalidComponentException
Throws:
InvalidComponentException

internalUnselectAccessibleRow

protected boolean internalUnselectAccessibleRow(int row)

getRowColumnExtentsAtIndex

public IA2RowColumnExtents getRowColumnExtentsAtIndex(int index)
                                               throws InvalidComponentException
Throws:
InvalidComponentException

internalGetRowColumnExtentsAtIndex

protected int[] internalGetRowColumnExtentsAtIndex(int index)

getTableModelChange

public IA2AccessibleTableModelChange getTableModelChange()
                                                  throws InvalidComponentException
Throws:
InvalidComponentException

internalGetModelChange

protected int[] internalGetModelChange()

getSelectedChildCount

public int getSelectedChildCount()
                          throws InvalidComponentException
Description copied from interface: IAccessibleTableElement
get the number of selected chidren for the table

Specified by:
getSelectedChildCount in interface IAccessibleTableElement
Returns:
selected children count
Throws:
InvalidComponentException

internalGetSelectedChildCount

protected int internalGetSelectedChildCount()

getSelectedChildren

public int[] getSelectedChildren()
                          throws InvalidComponentException
Description copied from interface: IAccessibleTableElement
get the indices of the selected Children

Specified by:
getSelectedChildren in interface IAccessibleTableElement
Returns:
an array of selected children indecies
Throws:
InvalidComponentException

internalGetSelectedChildren

protected int[] internalGetSelectedChildren()