public class FlexAdvancedDataGrid extends FlexListBase
The AdvancedDataGrid control is like a List control except that it can show more than one column of data, making it suited for showing objects with multiple properties.
Modifier | Constructor and Description |
---|---|
protected |
FlexAdvancedDataGrid(JtfObjectHandle handle,
Desktop desktop)
Creates a new FlexAdvancedDataGrid with a JtfObjectHandle.
|
Modifier and Type | Method and Description |
---|---|
void |
close(String itemRenderer)
Closes or collapses a AdvancedDataGrid branch.
|
void |
close(String itemRenderer,
FlexTriggerEvent triggerEvent)
Closes or collapses a AdvancedDataGrid branch.
|
void |
columnGroupedADGHeaderShift(int movingColumnIndex,
int newColumnIndex,
int oldColumnIndex)
Dispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index.
|
void |
columnGroupedADGHeaderShift(int movingColumnIndex,
int newColumnIndex,
int oldColumnIndex,
FlexTriggerEvent triggerEvent)
Dispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index.
|
void |
columnStretch(int columnIndex,
double localX)
Dispatched when a user changes the width of a column, indicating that the amount of data displayed in that column may have changed.
|
String |
getCellData(int rowIndex,
int columnIndex)
Returns data for a cell in the grid.
|
String |
getCellData(int rowIndex,
int columnIndex,
boolean restoreOriginalPosition)
Returns data for a cell in the grid.
|
List<Color> |
getDepthColors()
Gets the array of colors used for the rows of each level of the navigation tree of the AdvancedDataGrid control, in descending order.
|
List<Color> |
getDisabledColor()
Gets the color of text in the component if it is disabled.
|
int |
getGroupedItemChildrenCount(int rowIndex)
Returns the number of children within the first item of a group.
|
int |
getGroupedItemChildrenCount(int rowIndex,
boolean restoreOriginalPosition)
Returns the number of children within the first item of a group.
|
List<Color> |
getHeaderColors()
Gets an array of two colors used to draw the header background gradient.
|
double |
getHeaderHeight()
Gets the height of the header cell of the column, in pixels.
|
Color |
getHorizontalGridLineColor()
Gets the color of the horizontal grid lines.
|
int |
getIndentation()
Gets the indentation for each node of the navigation tree, in pixels.
|
double |
getMinColumnWidth()
Gets the minimum width of the columns, in pixels.
|
int |
getOpenDuration()
Gets the length of an open or close transition for the navigation tree, in milliseconds.
|
int |
getPaddingBottom()
Gets the number of pixels between the bottom of the row and the bottom of the renderer in the row.
|
int |
getPaddingLeft()
Gets the number of pixels between the control's left border and the left edge of its content area.
|
int |
getPaddingRight()
Gets the number of pixels between the control's right border and the right edge of its content area.
|
int |
getPaddingTop()
Gets the number of pixels between the top of the row and the top of the renderer in the row.
|
String |
getRowData(int rowIndex)
Returns data for the row of the item in the data provider.
|
String |
getRowData(int rowIndex,
boolean restoreOriginalPosition)
Returns data for the row of the item in the data provider.
|
String |
getSelectedCells()
Gets an Array of cell locations as row and column indices.
|
String |
getSelectionMode()
Gets the selection mode of the control.
|
Color |
getVerticalGridLineColor()
Gets the color of the vertical grid lines.
|
void |
headerClick(int columnIndex)
Dispatched when the user releases the mouse button on a column header to request the control to sort the grid contents based on the contents of the column.
|
void |
headerClick(int columnIndex,
String dataField)
Dispatched when the user releases the mouse button on a column header to request the control to sort the grid contents based on the contents of the column.
|
void |
headerClick(int columnIndex,
String dataField,
ModifierKey keyModifier)
Dispatched when the user releases the mouse button on a column header to request the control to sort the grid contents based on the contents of the column.
|
void |
headerShift(int newIndex,
int oldIndex)
Dispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index.
|
void |
headerShift(int newIndex,
int oldIndex,
FlexTriggerEvent triggerEvent)
Dispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index.
|
boolean |
isAllowDragSelection()
Gets whether drag-selection is enabled.
|
boolean |
isDisplayItemsExpanded()
Gets whether the navigation tree is expanded to show all items.
|
boolean |
isEditable()
Gets whether the user can edit items in the data provider.
|
boolean |
isGroupedItem(int rowIndex)
Returns a value that specifies whether the item is a member of a group.
|
boolean |
isGroupedItem(int rowIndex,
boolean restoreOriginalPosition)
Returns a value that specifies whether the item is a member of a group.
|
boolean |
isResizableColumns()
Gets whether the user can change the size of the columns.
|
void |
open(String itemRenderer)
Opens or expands an AdvancedDataGrid branch.
|
void |
open(String itemRenderer,
FlexTriggerEvent triggerEvent)
Opens or expands an AdvancedDataGrid branch.
|
deselect, deselect, deselect, doubleSelect, dragCancel, dragCancel, dragDrop, dragDrop, dragDrop, dragStart, dragStart, getAlternatingItemColors, getBackgroundDisabledColor, getColumnCount, getColumnNames, getColumnWidth, getDataTipField, getFirstVisibleRow, getFocusAlpha, getIconField, getLabelField, getLastVisibleRow, getLockedColumnCount, getLockedRowCount, getNumColumns, getNumRows, getRollOverColor, getRowCount, getRowHeight, getSelectedIndex, getSelectedIndices, getSelectedItem, getSelectedItems, getSelectionColor, getSelectionDisabledColor, getTextRollOverColor, getTextSelectedColor, getValues, getVerticalAlign, isAllowMultipleSelection, isSelectable, isShowDataTips, isUseRollOver, isVariableRowHeight, isWordWrap, multiSelect, multiSelect, multiSelect, scroll, scrollToIndex, select, select, select, selectIndex, selectIndex, selectIndex, type, type
mouseScroll, mouseScroll
changeFocus, changeFocus, changeFocus, getAutomationClassName, getAutomationIndex, getAutomationName, getClassName, getCurrentState, getErrorColor, getErrorString, getId, getNumAutomationChildren, getPercentHeight, getPercentWidth, getScaleX, getScaleY, getThemeColor, getToolTip, isEnabled, isFocusEnabled, isUseHandCursor, move, move, move, setFocus
click, click, click, click, doubleClick, doubleClick, doubleClick, doubleClick, getAlpha, getHeight, getStyle, getTabIndex, getWidth, getX, getY, isMouseEnabled, isTabChildren, isTabEnabled, isVisible, mouseMove, mouseMove, nativeToString, pressKeys, pressKeys, pressMouse, pressMouse, pressMouse, pressMouse, releaseKeys, releaseKeys, releaseMouse, releaseMouse, releaseMouse, releaseMouse, typeKeys, typeKeys, typeKeys, typePasswordKeys, typePasswordKeys, typePasswordKeys
captureBitmap, captureBitmap, exists, exists, generateLocator, getChildren, getDynamicMethodList, getParent, getPropertyList, getRect, getRect, getText, getValue, highlightObject, highlightObject, highlightObject, invokeMethods, textCapture, textCapture, textClick, textClick, textClick, textClick, textClick, textClick, textExists, textExists, textExists, textExists, textExists, textRectangle, textRectangle, textRectangle, textRectangle, textRectangle, waitForChildDisappearance, waitForChildDisappearance, waitForDisappearance, waitForDisappearance, waitForObject, waitForObject, waitForProperty, waitForProperty
equals, exists, find, find, findAll, findAll, getCustomTypeName, getDesktop, getHandle, getLocator, getProperty, getTypeName, hashCode, imageClick, imageClick, imageClick, imageClick, imageClick, imageClick, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageExists, imageExists, imageExists, imageExistsFile, imageExistsFile, imageExistsFile, imageRectangle, imageRectangle, imageRectangle, imageRectangleFile, imageRectangleFile, imageRectangleFile, invoke, preventFinalLocator, setProperty, toString
protected FlexAdvancedDataGrid(JtfObjectHandle handle, Desktop desktop)
handle
- the handle that identifies the FlexAdvancedDataGriddesktop
- the desktop on which this object livespublic void close(String itemRenderer)
itemRenderer
- the ListItemRenderer for the node that closedpublic void close(String itemRenderer, FlexTriggerEvent triggerEvent)
itemRenderer
- the ListItemRenderer for the node that closedtriggerEvent
- if the node closed in response to a user action, identifies it as a keyboard action or a mouse actionpublic void columnGroupedADGHeaderShift(int movingColumnIndex, int newColumnIndex, int oldColumnIndex)
movingColumnIndex
- the data provider index of the item to be selectednewColumnIndex
- the zero-based index after the changeoldColumnIndex
- the zero-based index before the changepublic void columnGroupedADGHeaderShift(int movingColumnIndex, int newColumnIndex, int oldColumnIndex, FlexTriggerEvent triggerEvent)
movingColumnIndex
- the data provider index of the item to be selectednewColumnIndex
- the zero-based index after the changeoldColumnIndex
- the zero-based index before the changetriggerEvent
- the event, such as a mouse or keyboard event, that triggered the selection actionpublic void columnStretch(int columnIndex, double localX)
columnIndex
- the zero-based index of the item's column in the DataGrid object's columns arraylocalX
- the x position of the mousepublic String getCellData(int rowIndex, int columnIndex)
rowIndex
- returns the zero-based index of the specified rowcolumnIndex
- returns the zero-based index of the specified columnpublic String getCellData(int rowIndex, int columnIndex, boolean restoreOriginalPosition)
rowIndex
- returns the zero-based index of the specified rowcolumnIndex
- returns the zero-based index of the specified columnrestoreOriginalPosition
- returns a cell in the grid to its previous positionpublic int getGroupedItemChildrenCount(int rowIndex)
rowIndex
- returns the zero-based index of the specified rowpublic int getGroupedItemChildrenCount(int rowIndex, boolean restoreOriginalPosition)
rowIndex
- returns the zero-based index of the specified rowrestoreOriginalPosition
- returns the children within the first item of a group to their previous positionpublic String getRowData(int rowIndex)
rowIndex
- returns the zero-based index of the item in the data providerpublic String getRowData(int rowIndex, boolean restoreOriginalPosition)
rowIndex
- returns the zero-based index of the item in the data providerrestoreOriginalPosition
- returns a row in the grid to its previous positionpublic void headerClick(int columnIndex)
columnIndex
- the zero-based index of the item's column in the DataGrid object's columns arraypublic void headerClick(int columnIndex, String dataField)
columnIndex
- the zero-based index of the item's column in the DataGrid object's columns arraydataField
- the name of the field or property in the data associated with the columnpublic void headerClick(int columnIndex, String dataField, ModifierKey keyModifier)
columnIndex
- the zero-based index of the item's column in the DataGrid object's columns arraydataField
- the name of the field or property in the data associated with the columnkeyModifier
- the key modifiers (for example, the Ctrl key) to usepublic void headerShift(int newIndex, int oldIndex)
newIndex
- the zero-based index of the header after the changeoldIndex
- the zero-based index of the header before the changepublic void headerShift(int newIndex, int oldIndex, FlexTriggerEvent triggerEvent)
newIndex
- the zero-based index of the header after the changeoldIndex
- the zero-based index of the header before the changetriggerEvent
- the event that triggered this eventpublic boolean isGroupedItem(int rowIndex)
rowIndex
- the row index of the selected itempublic boolean isGroupedItem(int rowIndex, boolean restoreOriginalPosition)
rowIndex
- the row index of the selected itemrestoreOriginalPosition
- returns an item of a group to its previous positionpublic void open(String itemRenderer)
itemRenderer
- the ListItemRenderer for the item (node) that openedpublic void open(String itemRenderer, FlexTriggerEvent triggerEvent)
itemRenderer
- the ListItemRenderer for the item (node) that openedtriggerEvent
- if the item (node) opened in response to a user action, identifies it as a keyboard action or a mouse actionpublic boolean isAllowDragSelection()
This feature is used in ComboBox dropdowns to support pressing the mouse button when the mouse is over the dropdown button then dragging the mouse into the dropdown to select an item.
The default value is false.
public List<Color> getDepthColors()
public List<Color> getDisabledColor()
public boolean isDisplayItemsExpanded()
If true, expand the navigation tree to show all items. If a new branch is added, it is shown expanded. The default value is false.
public boolean isEditable()
If true, the item renderers in the control are editable. The user can click on an item renderer to open an editor.
You can turn off editing for individual columns of the DataGrid control using the DataGridColumn.editable property, or by handling the itemEditBeginning and itemEditBegin events
The default value is false.
public List<Color> getHeaderColors()
The first color is the top color. The second color is the bottom color.
public double getHeaderHeight()
public Color getHorizontalGridLineColor()
public int getIndentation()
public double getMinColumnWidth()
public int getOpenDuration()
public int getPaddingBottom()
public int getPaddingLeft()
public int getPaddingRight()
public int getPaddingTop()
public boolean isResizableColumns()
If true, the user can stretch or shrink the columns of the DataGrid control by dragging the grid lines between the header cells. If false, individual columns must also have their resizable properties set to false to prevent the user from resizing a particular column. The default value is true.
public String getSelectedCells()
Changing the value of the selectionMode property sets this property to null.
public String getSelectionMode()
Possible values are: MULTIPLE_CELLS, MULTIPLE_ROWS, NONE, SINGLE_CELL, and SINGLE_ROW. Changing the value of this property sets the selectedCells property to null.
You must set the allowMultipleSelection property to true to select more than one item in the control at the same time.
Information about the selected cells is written to the selectedCells property.
The default value is SINGLE_ROW.
public Color getVerticalGridLineColor()
Copyright 2009-2012 Micro Focus. All Rights Reserved.