public class FlexDataGrid extends FlexListBase
Modifier | Constructor and Description |
---|---|
protected |
FlexDataGrid(JtfObjectHandle handle,
Desktop desktop)
Creates a new FlexDataGrid with a JtfObjectHandle.
|
Modifier and Type | Method and Description |
---|---|
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.
|
void |
edit(String itemRenderer,
int rowIndex,
int columnIndex)
Defines the value of the type property of the event object for a itemEditBegin event, which indicates that an item is ready to be edited.
|
List<Color> |
getHeaderColors()
Gets an array of two colors used to draw the header background gradient.
|
String |
getHeaderStyleName()
Gets the name of a CSS style declaration for controlling other aspects of the appearance of the column headers.
|
Color |
getHorizontalGridLineColor()
Gets the color of the horizontal grid lines.
|
double |
getMinColumnWidth()
Gets the minimum width of the columns, in pixels.
|
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 |
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 |
isEditable()
Gets whether the user can edit items in the data provider.
|
boolean |
isHorizontalGridLines()
Gets whether to show horizontal grid lines between the rows.
|
boolean |
isResizableColumns()
Gets whether the user can change the size of the columns.
|
boolean |
isSortableColumns()
Gets whether the user can sort the data provider items by clicking on a column header cell.
|
boolean |
isVerticalGridLines()
Gets whether to show vertical grid lines between the columns.
|
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 FlexDataGrid(JtfObjectHandle handle, Desktop desktop)
handle
- the handle that identifies the FlexDataGriddesktop
- the desktop on which this object livespublic void columnStretch(int columnIndex, double localX)
If horizontalScrollPolicy is "off", other columns shrink or expand to compensate for the columns' resizing, and they also dispatch this event.
columnIndex
- the zero-based index of the item's column in the DataGrid object's columns arraylocalX
- the x position of the mousepublic void edit(String itemRenderer, int rowIndex, int columnIndex)
itemRenderer
- the item renderer for the item that is being editedrowIndex
- the zero-based index of the item in the data providercolumnIndex
- the zero-based index of the item's column in the DataGrid object's columns
arraypublic void headerClick(int columnIndex)
Only dispatched if the column is sortable and the data provider supports sorting.
columnIndex
- the zero-based index of the item's column in the DataGrid object's columns arraypublic 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, such as a mouse or keyboard event, that triggered the actionpublic 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. The default value is [0xFFFFFF, 0xE6E6E6].
public String getHeaderStyleName()
dataGridStyles
.public Color getHorizontalGridLineColor()
public boolean isHorizontalGridLines()
If true, the data grid shows horizontal grid lines. If false, the data grid hides horizontal grid lines. The default value is false.
public double getMinColumnWidth()
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 specific column.
The default value is true.
public boolean isSortableColumns()
If true, the user can sort the data provider items by clicking on a column header cell. The DataGridColumn.dataField property of the column or the DataGridColumn.sortCompareFunction property of the column is used as the sort field. If a column is clicked more than once the sort alternates between ascending and descending order. If true, individual columns can be made to not respond to a click on a header by setting the column's sortable property to false.
When a user releases the mouse button over a header cell, the DataGrid control dispatches a headerRelease event if both this property and the column's sortable property are true. If no handler calls the preventDefault() method on the event, the DataGrid sorts using that column's DataGridColumn.dataField or DataGridColumn.sortCompareFunction properties.
The default value is true.
public Color getVerticalGridLineColor()
public boolean isVerticalGridLines()
If true, the data grid shows vertical grid lines. If false, the data grid hides vertical grid lines. The default value is true.
Copyright 2009-2012 Micro Focus. All Rights Reserved.