Class VisionAdvancedTable
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JScrollPane
com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
com.inductiveautomation.factorypmi.application.components.VisionAdvancedTable
- All Implemented Interfaces:
DynamicPropertyProvider
,LoadingMonitor
,CustomizableTable<AdvancedTableColumnAttributes>
,LocaleListener
,MutableDynamicPropertyProvider
,StyleProvider
,ComponentLifecycle
,EnabledEx
,ExtensibleComponent
,QualityMonitor
,VisionComponent
,ImageObserver
,MenuContainer
,Serializable
,Accessible
,ScrollPaneConstants
public class VisionAdvancedTable
extends AbstractVisionScrollPane
implements CustomizableTable<AdvancedTableColumnAttributes>, ExtensibleComponent, EnabledEx, LoadingMonitor
A Table component that features greater features like Drag and Drop rows, multi-column sorting, filtering, etc.
Titled "Power Table" in the designer/documentation.
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class javax.swing.JScrollPane
JScrollPane.AccessibleJScrollPane, JScrollPane.ScrollBar
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final DataFlavor
Fields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
antialias, context, cursorCode
Fields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewport
Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle
COMPONENT_RUNNING
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx
DISABLED_BY_PERMISSIONS
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener
LOCAL_CHANGE_EVENT
Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider
RESERVED_SET_KEY
Fields inherited from interface javax.swing.ScrollPaneConstants
COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent
COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
columnIndexToDatasetIndex
(int columnIndex) Converts between a TableColumnModel index and the underlying dataset's column index.int
columnIndexToModelIndex
(int columnIndex) Converts between a TableColumnModel index to the table model's column indexint
datasetIndexToColumnIndex
(int columnIndex) void
int
int
boolean
getData()
int
int
boolean
int
int[]
int
int[]
int
boolean
boolean
com.jidesoft.grid.JideTable
getTable()
boolean
getTest()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
localeChanged
(Locale newLocale) protected void
Subclasses should override this to provide startup logic.boolean
int
rowIndexToModelIndex
(int viewRow) void
setAutoResizeMode
(int i) void
setBackground
(Color bg) void
setCellSpanData
(Dataset cellSpanData) void
setClickCountToStart
(int i) void
setColumnAttributes
(Map<String, AdvancedTableColumnAttributes> attributes) void
void
setColumnReorderingAllowed
(boolean columnReorderingAllowed) void
setColumnResizingAllowed
(boolean columnResizingAllowed) void
setColumnSelectionAllowed
(boolean columnSelectionAllowed) void
setColumnWidth
(int idx, int width) void
setComponentEnabled
(boolean componentEnabled) void
void
setDefaultColumnView
(String defaultColumnView) void
void
void
setForeground
(Color fg) void
setGridColor
(Color gridColor) void
setHeaderColumnChooserMenus
(boolean headerColumnChooserMenus) void
setHeaderFont
(Font font) void
setHeaderResizeMenus
(boolean headerResizeMenus) void
setHeaderVisible
(boolean headerVisible) void
setInterCellSpacing
(Dimension spacing) void
setNonContiguousCellSelection
(boolean b) void
setPropertiesLoading
(int i) void
setRowDragEnabled
(boolean en) void
setRowHeight
(int rowHeight) void
setRowResizeEnabled
(boolean resize) void
setRowSelectionAllowed
(boolean rowSelectionAllowed) void
setSelectedColumn
(int col) Sets the selected column with respect to the underlying dataset.void
setSelectedRow
(int row) void
setSelectionBackground
(Color selectionBackground) void
setSelectionForeground
(Color selectionForeground) void
setSelectionMode
(int i) void
setShowHorizontalLines
(boolean showHorizontalLines) void
setShowVerticalLines
(boolean showVerticalLines) void
setSortingEnabled
(boolean en) void
setTest
(boolean test) void
setViewDataset
(Dataset viewDataset) boolean
make sure that the widths on the ColumnAttributes represent the currently configured widths of the actual columnsMethods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
getAppContext, getCursorCode, getDataQuality, getDynamicProps, getProperties, getPropertyValue, getQuality, getStyles, getToolTipText, initStyleListener, isAntialias, isComponentRunning, isPropertyDefined, onShutdown, paintChildren, paintComponent, setAntialias, setCursorCode, setDataQuality, setDynamicProps, setName, setPropertyValue, setQuality, setStyles, setToolTipText, setVisible, shutdownComponent, startupComponent, updateQuality
Methods inherited from class javax.swing.JScrollPane
createHorizontalScrollBar, createVerticalScrollBar, createViewport, getAccessibleContext, getColumnHeader, getCorner, getHorizontalScrollBar, getHorizontalScrollBarPolicy, getRowHeader, getUI, getUIClassID, getVerticalScrollBar, getVerticalScrollBarPolicy, getViewport, getViewportBorder, getViewportBorderBounds, isValidateRoot, isWheelScrollingEnabled, paramString, setColumnHeader, setColumnHeaderView, setComponentOrientation, setCorner, setHorizontalScrollBar, setHorizontalScrollBarPolicy, setLayout, setRowHeader, setRowHeaderView, setUI, setVerticalScrollBar, setVerticalScrollBarPolicy, setViewport, setViewportBorder, setViewportView, setWheelScrollingEnabled, updateUI
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, paint, paintBorder, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle
getAppContext, shutdownComponent, startupComponent
-
Field Details
-
AUTO_COL_RESIZE_TERM
- See Also:
-
AUTO_RESIZE_ALL_TERM
- See Also:
-
HIDE_COLUMN_TERM
- See Also:
-
RESET_TO_DEFAULT_TERM
- See Also:
-
MORE_TERM
- See Also:
-
selectedRowsFlavor
-
-
Constructor Details
-
VisionAdvancedTable
public VisionAdvancedTable()
-
-
Method Details
-
localeChanged
- Specified by:
localeChanged
in interfaceLocaleListener
- Overrides:
localeChanged
in classAbstractVisionScrollPane
-
getViewDataset
-
setViewDataset
-
onStartup
protected void onStartup()Description copied from class:AbstractVisionScrollPane
Subclasses should override this to provide startup logic.- Overrides:
onStartup
in classAbstractVisionScrollPane
-
getSelectedRows
public int[] getSelectedRows() -
getSelectedColumns
public int[] getSelectedColumns() -
setColumnWidth
public void setColumnWidth(int idx, int width) -
getSelectedRow
public int getSelectedRow() -
getSelectedColumn
public int getSelectedColumn() -
setSelectedColumn
public void setSelectedColumn(int col) Sets the selected column with respect to the underlying dataset. If the column is out of range, the selection is not changed.- Parameters:
col
- Index number of column to be selected; zero-indexed.
-
rowIndexToModelIndex
public int rowIndexToModelIndex(int viewRow) -
columnIndexToModelIndex
public int columnIndexToModelIndex(int columnIndex) Converts between a TableColumnModel index to the table model's column index -
columnIndexToDatasetIndex
public int columnIndexToDatasetIndex(int columnIndex) Converts between a TableColumnModel index and the underlying dataset's column index. -
datasetIndexToColumnIndex
public int datasetIndexToColumnIndex(int columnIndex) -
setSelectedRow
public void setSelectedRow(int row) -
isHeaderResizeMenus
public boolean isHeaderResizeMenus() -
setHeaderResizeMenus
public void setHeaderResizeMenus(boolean headerResizeMenus) -
isHeaderColumnChooserMenus
public boolean isHeaderColumnChooserMenus() -
setHeaderColumnChooserMenus
public void setHeaderColumnChooserMenus(boolean headerColumnChooserMenus) -
isColumnReorderingAllowed
public boolean isColumnReorderingAllowed() -
setColumnReorderingAllowed
public void setColumnReorderingAllowed(boolean columnReorderingAllowed) -
isColumnResizingAllowed
public boolean isColumnResizingAllowed() -
setColumnResizingAllowed
public void setColumnResizingAllowed(boolean columnResizingAllowed) -
isHeaderVisible
public boolean isHeaderVisible() -
setHeaderVisible
public void setHeaderVisible(boolean headerVisible) -
setHeaderFont
-
getHeaderFont
-
getData
- Specified by:
getData
in interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
setData
-
getCellSpanData
-
setCellSpanData
-
setFont
- Overrides:
setFont
in classJComponent
-
setForeground
- Overrides:
setForeground
in classJComponent
-
setBackground
- Overrides:
setBackground
in classJComponent
-
getClickCountToStart
public int getClickCountToStart() -
setClickCountToStart
public void setClickCountToStart(int i) -
getSelectionBackground
-
getSelectionForeground
-
setSelectionForeground
-
setSelectionBackground
-
getSelectionMode
public int getSelectionMode() -
setSelectionMode
public void setSelectionMode(int i) -
getColumnSelectionAllowed
public boolean getColumnSelectionAllowed() -
getRowSelectionAllowed
public boolean getRowSelectionAllowed() -
setColumnSelectionAllowed
public void setColumnSelectionAllowed(boolean columnSelectionAllowed) -
setRowSelectionAllowed
public void setRowSelectionAllowed(boolean rowSelectionAllowed) -
isNonContiguousCellSelection
public boolean isNonContiguousCellSelection() -
setNonContiguousCellSelection
public void setNonContiguousCellSelection(boolean b) -
getShowHorizontalLines
public boolean getShowHorizontalLines() -
setShowHorizontalLines
public void setShowHorizontalLines(boolean showHorizontalLines) -
getShowVerticalLines
public boolean getShowVerticalLines() -
setShowVerticalLines
public void setShowVerticalLines(boolean showVerticalLines) -
getGridColor
-
setGridColor
-
setInterCellSpacing
-
getInterCellSpacing
-
getAutoResizeMode
public int getAutoResizeMode() -
setAutoResizeMode
public void setAutoResizeMode(int i) -
getPropertiesLoading
public int getPropertiesLoading()- Specified by:
getPropertiesLoading
in interfaceLoadingMonitor
-
setPropertiesLoading
public void setPropertiesLoading(int i) - Specified by:
setPropertiesLoading
in interfaceLoadingMonitor
-
getRowHeight
public int getRowHeight() -
setRowHeight
public void setRowHeight(int rowHeight) -
isRowResizeEnabled
public boolean isRowResizeEnabled() -
setRowResizeEnabled
public void setRowResizeEnabled(boolean resize) -
isRowDragEnabled
public boolean isRowDragEnabled() -
setRowDragEnabled
public void setRowDragEnabled(boolean en) -
isSortingEnabled
public boolean isSortingEnabled() -
setSortingEnabled
public void setSortingEnabled(boolean en) -
getTable
public com.jidesoft.grid.JideTable getTable() -
getExtensionFunctions
- Specified by:
getExtensionFunctions
in interfaceExtensibleComponent
-
setExtensionFunctions
- Specified by:
setExtensionFunctions
in interfaceExtensibleComponent
-
isComponentEnabled
public boolean isComponentEnabled()- Specified by:
isComponentEnabled
in interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled) - Specified by:
setComponentEnabled
in interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()- Specified by:
evaluateEnabled
in interfaceEnabledEx
-
getDefaultColumnView
-
setDefaultColumnView
-
setTest
public void setTest(boolean test) -
getTest
public boolean getTest() -
print
-
updateWidths
public boolean updateWidths()Description copied from interface:CustomizableTable
make sure that the widths on the ColumnAttributes represent the currently configured widths of the actual columns- Specified by:
updateWidths
in interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
getColumnAttributes
- Specified by:
getColumnAttributes
in interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
setColumnAttributes
- Specified by:
setColumnAttributes
in interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
getColumnAttributesData
-
setColumnAttributesData
-