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.ScrollBarNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final DataFlavorFields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionScrollPane
antialias, context, cursorCodeFields inherited from class javax.swing.JScrollPane
columnHeader, horizontalScrollBar, horizontalScrollBarPolicy, lowerLeft, lowerRight, rowHeader, upperLeft, upperRight, verticalScrollBar, verticalScrollBarPolicy, viewportFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle
COMPONENT_RUNNINGFields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx
DISABLED_BY_PERMISSIONSFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener
LOCAL_CHANGE_EVENTFields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider
RESERVED_SET_KEYFields 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, VIEWPORTFields 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 TypeMethodDescriptionintcolumnIndexToDatasetIndex(int columnIndex) Converts between a TableColumnModel index and the underlying dataset's column index.intcolumnIndexToModelIndex(int columnIndex) Converts between a TableColumnModel index to the table model's column indexintdatasetIndexToColumnIndex(int columnIndex) voidintintbooleangetData()intintbooleanintint[]intint[]intbooleanbooleancom.jidesoft.grid.JideTablegetTable()booleangetTest()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanvoidlocaleChanged(Locale newLocale) protected voidSubclasses should override this to provide startup logic.booleanintrowIndexToModelIndex(int viewRow) voidsetAutoResizeMode(int i) voidsetBackground(Color bg) voidsetCellSpanData(Dataset cellSpanData) voidsetClickCountToStart(int i) voidsetColumnAttributes(Map<String, AdvancedTableColumnAttributes> attributes) voidvoidsetColumnReorderingAllowed(boolean columnReorderingAllowed) voidsetColumnResizingAllowed(boolean columnResizingAllowed) voidsetColumnSelectionAllowed(boolean columnSelectionAllowed) voidsetColumnWidth(int idx, int width) voidsetComponentEnabled(boolean componentEnabled) voidvoidsetDefaultColumnView(String defaultColumnView) voidvoidvoidsetForeground(Color fg) voidsetGridColor(Color gridColor) voidsetHeaderColumnChooserMenus(boolean headerColumnChooserMenus) voidsetHeaderFont(Font font) voidsetHeaderResizeMenus(boolean headerResizeMenus) voidsetHeaderVisible(boolean headerVisible) voidsetInterCellSpacing(Dimension spacing) voidsetNonContiguousCellSelection(boolean b) voidsetPropertiesLoading(int i) voidsetRowDragEnabled(boolean en) voidsetRowHeight(int rowHeight) voidsetRowResizeEnabled(boolean resize) voidsetRowSelectionAllowed(boolean rowSelectionAllowed) voidsetSelectedColumn(int col) Sets the selected column with respect to the underlying dataset.voidsetSelectedRow(int row) voidsetSelectionBackground(Color selectionBackground) voidsetSelectionForeground(Color selectionForeground) voidsetSelectionMode(int i) voidsetShowHorizontalLines(boolean showHorizontalLines) voidsetShowVerticalLines(boolean showVerticalLines) voidsetSortingEnabled(boolean en) voidsetTest(boolean test) voidsetViewDataset(Dataset viewDataset) booleanmake 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, updateQualityMethods 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, updateUIMethods 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, updateMethods 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, validateTreeMethods 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, transferFocusUpCycleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods 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:
localeChangedin interfaceLocaleListener- Overrides:
localeChangedin classAbstractVisionScrollPane
-
getViewDataset
-
setViewDataset
-
onStartup
protected void onStartup()Description copied from class:AbstractVisionScrollPaneSubclasses should override this to provide startup logic.- Overrides:
onStartupin 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:
getDatain interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
setData
-
getCellSpanData
-
setCellSpanData
-
setFont
- Overrides:
setFontin classJComponent
-
setForeground
- Overrides:
setForegroundin classJComponent
-
setBackground
- Overrides:
setBackgroundin 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:
getPropertiesLoadingin interfaceLoadingMonitor
-
setPropertiesLoading
public void setPropertiesLoading(int i) - Specified by:
setPropertiesLoadingin 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:
getExtensionFunctionsin interfaceExtensibleComponent
-
setExtensionFunctions
- Specified by:
setExtensionFunctionsin interfaceExtensibleComponent
-
isComponentEnabled
public boolean isComponentEnabled()- Specified by:
isComponentEnabledin interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled) - Specified by:
setComponentEnabledin interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()- Specified by:
evaluateEnabledin interfaceEnabledEx
-
getDefaultColumnView
-
setDefaultColumnView
-
setTest
public void setTest(boolean test) -
getTest
public boolean getTest() -
print
-
updateWidths
public boolean updateWidths()Description copied from interface:CustomizableTablemake sure that the widths on the ColumnAttributes represent the currently configured widths of the actual columns- Specified by:
updateWidthsin interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
getColumnAttributes
- Specified by:
getColumnAttributesin interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
setColumnAttributes
- Specified by:
setColumnAttributesin interfaceCustomizableTable<AdvancedTableColumnAttributes>
-
getColumnAttributesData
-
setColumnAttributesData
-