GuiGridView class

An SAP ALV Grid View control (type 122 — GuiShell subclass).

Provides cell-level access: getCellValue, modifyCell, doubleClick, pressButton, modifyCheckBox, and cell navigation properties (currentCellRow, currentCellColumn, rowCount, columnCount).

Also supports toolbar interaction within the grid: pressToolbarButton, selectToolbarMenuItem, and pressEnter.

GuiGridView? grid = session.findGridView('wnd[0]/usr/cntlGRID1/shellcont/shell');
if (grid != null) {
  for (int row = 0; row < grid.rowCount; row++) {
    String name = grid.getCellValue(row, 'NAME1');
    doubleClick(row, 'NAME1');
  }
}
Inheritance

Constructors

GuiGridView(ISapObject obj)

Properties

accDescription → String
no setterinherited
accLabelCollection → GuiComponentCollection<GuiLabel>
no setterinherited
accText → String
no setterinherited
accTextOnRequest → String
no setterinherited
accTooltip → String
no setterinherited
changeable → bool
no setterinherited
children → GuiComponentCollection<GuiComponent>
no setterinherited
columnCount → int
no setter
columnOrder ↔ List<String>?
getter/setter pair
containerType → bool
no setterinherited
currentCellColumn ↔ String
getter/setter pair
currentCellRow ↔ int
getter/setter pair
defaultTooltip → String
no setterinherited
dragDropSupported → bool
no setterinherited
firstVisibleColumn ↔ String
getter/setter pair
firstVisibleRow ↔ int
getter/setter pair
frozenColumnCount → int
no setter
handle → int
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
height → int
no setterinherited
iconName → String
no setterinherited
id → String
no setterinherited
isSymbolFont → bool
no setterinherited
left → int
no setterinherited
modified ↔ bool
getter/setter pairinherited
name → String
no setterinherited
obj → ISapObject
finalinherited
ocxEvents → ISapObject?
no setterinherited
parent → GuiComponent?
no setterinherited
parentFrame → GuiComponent?
no setterinherited
rowCount → int
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
screenLeft → int
no setterinherited
screenTop → int
no setterinherited
selectedCells ↔ List<String>?
getter/setter pair
selectedColumns ↔ List<String>?
getter/setter pair
selectedRows ↔ String
getter/setter pair
selectionMode → String
no setter
subType → String
no setterinherited
text ↔ String
getter/setter pairinherited
title → String
no setter
toolbarButtonCount → int
no setter
tooltip → String
no setterinherited
top → int
no setterinherited
type → String
no setterinherited
typeAsNumber → int
no setterinherited
visibleRowCount → int
no setter
width → int
no setterinherited

Methods

clearSelection() → void
click(int row, String column) → void
clickCurrentCell() → void
contextMenu() → void
currentCellMoved() → void
deleteRows(String rows) → void
rows format: "3,5-8,14,15"
deselectColumn(String column) → void
doubleClick(int row, String column) → void
doubleClickCurrentCell() → void
dumpState([String innerObject = ""]) → GuiComponentCollection<GuiComponent>
inherited
duplicateRows(String rows) → void
findAllByName(String name, String type) → GuiComponentCollection<GuiComponent>
inherited
findAllByNameEx(String name, int typeAsNumber) → GuiComponentCollection<GuiComponent>
inherited
findBarChart(String id, {bool raise = true}) → GuiBarChart?
inherited
findBox(String id, {bool raise = true}) → GuiBox?
inherited
findButton(String id, {bool raise = true}) → GuiButton?
inherited
findById(String id, {bool raise = true}) → ISapObject?
inherited
findByName(String name, String type) → GuiComponent?
inherited
findByNameEx(String name, int typeAsNumber) → GuiComponent?
inherited
findCalendar(String id, {bool raise = true}) → GuiCalendar?
inherited
findChart(String id, {bool raise = true}) → GuiChart?
inherited
findCheckBox(String id, {bool raise = true}) → GuiCheckBox?
inherited
findComboBox(String id, {bool raise = true}) → GuiComboBox?
inherited
findComboBoxControl(String id, {bool raise = true}) → GuiComboBoxControl?
inherited
findComboBoxEntry(String id, {bool raise = true}) → GuiComboBoxEntry?
inherited
findComponent(String id, {bool raise = true}) → GuiComponent?
inherited
findContainerShell(String id, {bool raise = true}) → GuiContainerShell?
inherited
findCTextField(String id, {bool raise = true}) → GuiCTextField?
inherited
findCustomControl(String id, {bool raise = true}) → GuiCustomControl?
inherited
findDialogShell(String id, {bool raise = true}) → GuiDialogShell?
inherited
findDockShell(String id, {bool raise = true}) → GuiDockShell?
inherited
findEAIViewer2D(String id, {bool raise = true}) → GuiEAIViewer2D?
inherited
findEAIViewer3D(String id, {bool raise = true}) → GuiEAIViewer3D?
inherited
findFrameWindow(String id, {bool raise = true}) → GuiFrameWindow?
inherited
findGOSShell(String id, {bool raise = true}) → GuiGOSShell?
inherited
findGridView(String id, {bool raise = true}) → GuiGridView?
inherited
findHTMLViewer(String id, {bool raise = true}) → GuiHTMLViewer?
inherited
findInputFieldControl(String id, {bool raise = true}) → GuiInputFieldControl?
inherited
findLabel(String id, {bool raise = true}) → GuiLabel?
inherited
findMainWindow(String id, {bool raise = true}) → GuiMainWindow?
inherited
findMenu(String id, {bool raise = true}) → GuiMenu?
inherited
findMenuBar(String id, {bool raise = true}) → GuiMenuBar?
inherited
findMessageWindow(String id, {bool raise = true}) → GuiMessageWindow?
inherited
findNetChart(String id, {bool raise = true}) → GuiNetChart?
inherited
findOfficeIntegration(String id, {bool raise = true}) → GuiOfficeIntegration?
inherited
findOkCodeField(String id, {bool raise = true}) → GuiOkCodeField?
inherited
findPicture(String id, {bool raise = true}) → GuiPicture?
inherited
findRadioButton(String id, {bool raise = true}) → GuiRadioButton?
inherited
findSapChart(String id, {bool raise = true}) → GuiSapChart?
inherited
findScrollBar(String id, {bool raise = true}) → GuiScrollbar?
inherited
findScrollContainer(String id, {bool raise = true}) → GuiScrollContainer?
inherited
findShell(String id, {bool raise = true}) → GuiShell?
inherited
findSimpleContainer(String id, {bool raise = true}) → GuiSimpleContainer?
inherited
findSplitterContainer(String id, {bool raise = true}) → GuiSplitterContainer?
inherited
findSplitterShell(String id, {bool raise = true}) → GuiSplit?
inherited
findStage(String id, {bool raise = true}) → GuiStage?
inherited
findStatusbar(String id, {bool raise = true}) → GuiStatusbar?
inherited
inherited
findStatusPane(String id, {bool raise = true}) → GuiStatusPane?
inherited
findTab(String id, {bool raise = true}) → GuiTab?
inherited
findTableControl(String id, {bool raise = true}) → GuiTableControl?
inherited
findTabStrip(String id, {bool raise = true}) → GuiTabStrip?
inherited
findTextedit(String id, {bool raise = true}) → GuiTextedit?
inherited
findTextField(String id, {bool raise = true}) → GuiTextField?
inherited
findTitlebar(String id, {bool raise = true}) → GuiTitlebar?
inherited
findToolbar(String id, {bool raise = true}) → GuiToolbar?
inherited
findToolbarControl(String id, {bool raise = true}) → GuiToolbarControl?
inherited
findTree(String id, {bool raise = true}) → GuiTree?
inherited
findUserArea(String id, {bool raise = true}) → GuiUserArea?
inherited
findVHViewSwitch(String id, {bool raise = true}) → GuiVHViewSwitch?
inherited
getCellChangeable(int row, String column) → bool
getCellCheckBoxChecked(int row, String column) → bool
getCellColor(int row, String column) → int
getCellHeight(int row, String column) → int
getCellHotspotType(int row, String column) → String
getCellIcon(int row, String column) → String
getCellLeft(int row, String column) → int
getCellListBoxCount(int row, String column) → int
getCellListBoxCurIndex(int row, String column) → String
getCellMaxLength(int row, String column) → int
getCellState(int row, String column) → String
getCellTooltip(int row, String column) → String
getCellTop(int row, String column) → int
getCellType(int row, String column) → String
getCellValue(int row, String column) → String
getCellWidth(int row, String column) → int
getColorInfo(int color) → String
getColumnDataType(String column) → String
getColumnOperationType(String column) → String
getColumnPosition(String column) → int
getColumnSortType(String column) → String
getColumnTitles(String column) → List<String>?
getColumnTooltip(String column) → String
getColumnTotalType(String column) → String
getDisplayedColumnTitle(String column) → String
getRowTotalLevel(int row) → int
getSymbolInfo(String symbol) → String
getToolbarButtonChecked(int buttonPos) → bool
getToolbarButtonEnabled(int buttonPos) → bool
getToolbarButtonIcon(int buttonPos) → String
getToolbarButtonId(int buttonPos) → String
getToolbarButtonText(int buttonPos) → String
getToolbarButtonTooltip(int buttonPos) → String
getToolbarButtonType(int buttonPos) → String
getToolbarFocusButton() → int
hasCellF4Help(int row, String column) → bool
historyCurEntry(int row, String column) → String
historyCurIndex(int row, String column) → int
historyIsActive(int row, String column) → bool
historyList(int row, String column) → ISapObject?
insertRows(String rows) → void
isCellHotspot(int row, String column) → bool
isCellSymbol(int row, String column) → bool
isCellTotalExpander(int row, String column) → bool
isColumnFiltered(String column) → bool
isColumnKey(String column) → bool
isTotalRowExpanded(int row) → bool
modifyCell(int row, String column, String value) → void
modifyCheckBox(int row, String column, bool checked) → void
moveRows(int fromRow, int toRow, int destRow) → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pressButton(int row, String column) → void
pressButtonCurrentCell() → void
pressColumnHeader(String column) → void
pressEnter() → void
pressF1() → void
pressF4() → void
pressToolbarButton(String id) → void
pressToolbarContextButton(String id) → void
pressTotalRow(int row, String column) → void
pressTotalRowCurrentCell() → void
selectAll() → void
selectColumn(String column) → void
selectContextMenuItem(String functionCode) → void
inherited
selectContextMenuItemByPosition(String positionDesc) → void
inherited
selectContextMenuItemByText(String text) → void
inherited
selectionChanged() → void
selectToolbarMenuItem(String id) → void
setColumnWidth(String column, int width) → void
setCurrentCell(int row, String column) → void
setFocus() → void
inherited
toString() → String
A string representation of this object.
inherited
triggerModified() → void
visualize(bool on, [String innerObject = ""]) → int
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited