Class ReportingResourceWorkspace
- java.lang.Object
- 
- java.awt.Component
- 
- java.awt.Container
- 
- javax.swing.JComponent
- 
- javax.swing.JTabbedPane
- 
- com.jidesoft.swing.JideTabbedPane
- 
- com.inductiveautomation.ignition.designer.tabbedworkspace.TabbedResourceWorkspace
- 
- com.inductiveautomation.reporting.designer.workspace.ReportingResourceWorkspace
 
 
 
 
 
 
 
- 
- All Implemented Interfaces:
- ResourceWorkspace,- java.awt.image.ImageObserver,- java.awt.MenuContainer,- java.io.Serializable,- javax.accessibility.Accessible,- javax.swing.SwingConstants
 
 public class ReportingResourceWorkspace extends TabbedResourceWorkspace Is the tabbed workspace for reports, extended to allow Report Resource types, and their customized leaf node structure. Extending TabbedResourceWorkspace allows for simple integration into the project nav tree and minimized- See Also:
- Serialized Form
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classReportingResourceWorkspace.NewReportResourceActionclassReportingResourceWorkspace.ReportDesignerEditActionHandlerclassReportingResourceWorkspace.ReportToolbarHandlerstatic classReportingResourceWorkspace.SnapshotUpdaterBackground worker that resizes a byte[] to 250x300 for display in thumbnails/preview panels.classReportingResourceWorkspace.ZoomAction- 
Nested classes/interfaces inherited from class com.jidesoft.swing.JideTabbedPanecom.jidesoft.swing.JideTabbedPane.ColorProvider, com.jidesoft.swing.JideTabbedPane.GradientColorProvider, com.jidesoft.swing.JideTabbedPane.IgnoreableSingleSelectionModel, com.jidesoft.swing.JideTabbedPane.NoFocusButton, com.jidesoft.swing.JideTabbedPane.PageLastFocusTracker, com.jidesoft.swing.JideTabbedPane.TabListCellRenderer
 - 
Nested classes/interfaces inherited from class javax.swing.JTabbedPanejavax.swing.JTabbedPane.AccessibleJTabbedPane, javax.swing.JTabbedPane.ModelListener
 - 
Nested classes/interfaces inherited from class javax.swing.JComponentjavax.swing.JComponent.AccessibleJComponent
 
- 
 - 
Field SummaryFields Modifier and Type Field Description static ResourceDescriptorDESCRIPTORstatic intDESIGNER_TOOLBAR_INDEXstatic java.lang.StringREPORT_DESIGNER_PROPNAMEstatic java.lang.StringWORKSPACE_KEY- 
Fields inherited from class com.inductiveautomation.ignition.designer.tabbedworkspace.TabbedResourceWorkspacecontext, descriptor, editors, listeners, rootNode
 - 
Fields inherited from class com.jidesoft.swing.JideTabbedPane_focusChangeListener, _tabEditingAllowed, _tabEditValidator, BOLDACTIVETAB_PROPERTY, BOX_STYLE_PROPERTY, BUTTON_CLOSE, BUTTON_EAST, BUTTON_LIST, BUTTON_NORTH, BUTTON_SOUTH, BUTTON_WEST, COLOR_THEME_DEFAULT, COLOR_THEME_OFFICE2003, COLOR_THEME_VSNET, COLOR_THEME_WIN2K, COLOR_THEME_WINXP, GRIPPER_PROPERTY, HIDE_IF_ONE_TAB_PROPERTY, ONENOTE_COLOR_PROVIDER, PROPERTY_COLOR_THEME, PROPERTY_CONTENT_BORDER_INSETS, PROPERTY_DRAG_OVER_DISABLED, PROPERTY_SELECTED_INDEX, PROPERTY_SHOW_CLOSE_BUTTON_ON_MOUSE_OVER, PROPERTY_TAB_AREA_INSETS, PROPERTY_TAB_COLOR_PROVIDER, PROPERTY_TAB_INSETS, PROPERTY_TAB_LEADING_COMPONENT, PROPERTY_TAB_RESIZE_MODE, PROPERTY_TAB_SHAPE, PROPERTY_TAB_TRAILING_COMPONENT, RESIZE_MODE_COMPRESSED, RESIZE_MODE_DEFAULT, RESIZE_MODE_FIT, RESIZE_MODE_FIXED, RESIZE_MODE_NONE, SCROLL_TAB_ON_WHEEL_PROPERTY, SHAPE_BOX, SHAPE_DEFAULT, SHAPE_ECLIPSE, SHAPE_ECLIPSE3X, SHAPE_EXCEL, SHAPE_FLAT, SHAPE_OFFICE2003, SHAPE_ROUNDED_FLAT, SHAPE_ROUNDED_VSNET, SHAPE_VSNET, SHAPE_WINDOWS, SHAPE_WINDOWS_SELECTED, SHOW_CLOSE_BUTTON_ON_TAB_PROPERTY, SHOW_CLOSE_BUTTON_PROPERTY, SHOW_ICONS_PROPERTY, SHOW_TAB_AREA_PROPERTY, SHOW_TAB_BUTTONS_PROPERTY, SHOW_TAB_CONTENT_PROPERTY, SHRINK_TAB_PROPERTY, TAB_CLOSABLE_PROPERTY, USE_DEFAULT_SHOW_CLOSE_BUTTON_ON_TAB_PROPERTY, USE_DEFAULT_SHOW_ICONS_PROPERTY
 - 
Fields inherited from class javax.swing.JTabbedPanechangeEvent, changeListener, model, SCROLL_TAB_LAYOUT, tabPlacement, WRAP_TAB_LAYOUT
 - 
Fields inherited from class javax.swing.JComponentlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 - 
Fields inherited from class java.awt.ComponentaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
- 
 - 
Constructor SummaryConstructors Constructor Description ReportingResourceWorkspace(DesignerContext context)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddNewResourceActions(ResourceFolderNode folder, javax.swing.JPopupMenu menu)This is where you add the menu items to create new nodes.protected AbstractNavTreeNodecreateRootNavTreeNode()protected java.util.Optional<javax.swing.JComponent>createWorkspaceHomeTab()voiddispose()Called when the workspace should be completely disposed.DesignerMenugetDesignerMenu()EditActionHandlergetEditActionHandler()The handler that responds to common edit actions, like cut, copy, paste, and deletejava.util.Collection<ResourceWorkspaceFrame>getFrames()Returns a collection ofResourceWorkspaceFrames that will be associated with this workspace.InspectorFramegetInspectorFrame()java.lang.StringgetKey()Returns a keyname for the workspace.MenuBarMergegetMenu()Returns a menu merge for the menu options that should be present when this workspace is active.ReportingResourceEditorgetSelectedEditor()java.util.List<com.jidesoft.action.CommandBar>getToolbars()Returns the toolbars that will be added when this workspace is active.protected ResourceEditornewResourceEditor(ResourcePath id)This is where you create a newResourceEditorfor displaying and editing your resource.voidonActivation()Called when the resource workspace will become the active workspace and will be displayed.voidonDeactivation()Called when the resource workspace will be swapped out for a different workspace.voidresetFrames(com.jidesoft.docking.DockingManager dockingManager, com.jidesoft.action.DockableBarManager barManager)Programmatically set the options on the frames and bars that represent the workspace's "defaults"- 
Methods inherited from class com.inductiveautomation.ignition.designer.tabbedworkspace.TabbedResourceWorkspaceaddTabbedWorkspaceListener, close, close, commit, commitAll, findEditor, getContext, getDescriptor, getEditors, getNavTreeNodeParent, getRootNode, getTabPopupMenu, getWorkspace, isOpen, open, registerNavTreeNode, removeTabbedWorkspaceListener, setupWorkspaceHomeTab
 - 
Methods inherited from class com.jidesoft.swing.JideTabbedPaneadd, addNotify, addTabEditingListener, calculateTabListPopupPosition, cancelTabEditing, clearVisComp, createFocusChangeListener, createNoFocusButton, createTabList, createTabListPopup, editTabAt, fireStateChanged, fireTabEditing, getCloseAction, getColorTheme, getContentBorderInsets, getDefaultColorTheme, getDefaultTabResizeMode, getDefaultTabStyle, getDisplayTitleAt, getEditingTabIndex, getIconForTab, getLastFocusedComponent, getPageLastFocusTrackers, getResourceString, getSelectedTabFont, getStringConverter, getTabAlignment, getTabAreaInsets, getTabAtLocation, getTabColorProvider, getTabEditingListeners, getTabEditingValidator, getTabHeight, getTabInsets, getTabLeadingComponent, getTabListCellRenderer, getTabResizeMode, getTabShape, getTabTrailingComponent, getUI, getUIClassID, hasFocusComponent, hideTabListPopup, insertTab, isAutoFocusOnTabHideClose, isAutoRequestFocus, isBoldActiveTab, isCloseTabOnMouseMiddleButton, isDragOverDisabled, isHideOneTab, isHideTrailingWhileNoButtons, isLayoutTrailingComponentBeforeButtons, isRightClickSelect, isScrollSelectedTabOnWheel, isShowCloseButton, isShowCloseButtonOnMouseOver, isShowCloseButtonOnSelectedTab, isShowCloseButtonOnTab, isShowGripper, isShowIconsOnTab, isShowTabArea, isShowTabButtons, isShowTabContent, isSuppressSetSelectedIndex, isSuppressStateChangedEvents, isTabClosableAt, isTabEditing, isTabEditingAllowed, isTabListPopupVisible, isTabShown, isUseDefaultShowCloseButtonOnTab, isUseDefaultShowIconsOnTab, moveSelectedTabTo, popupSelectedIndex, processMouseSelection, removeAll, removeNotify, removeTabAt, removeTabEditingListener, repaintContentBorder, repaintTabAreaAndContentBorder, requestFocusForVisibleComponent, resetDefaultCloseAction, scrollSelectedTabToVisible, setAutoFocusOnTabHideClose, setAutoRequestFocus, setBoldActiveTab, setCloseAction, setCloseTabOnMouseMiddleButton, setColorTheme, setComponentAt, setContentBorderInsets, setDragOverDisabled, setHideOneTab, setHideTrailingWhileNoButtons, setLayoutTrailingComponentBeforeButtons, setRightClickSelect, setScrollSelectedTabOnWheel, setSelectedIndex, setSelectedTabFont, setShowCloseButton, setShowCloseButtonOnMouseOver, setShowCloseButtonOnSelectedTab, setShowCloseButtonOnTab, setShowGripper, setShowIconsOnTab, setShowTabArea, setShowTabButtons, setShowTabContent, setStringConverter, setSuppressSetSelectedIndex, setSuppressStateChangedEvents, setTabAlignment, setTabAreaInsets, setTabClosableAt, setTabColorProvider, setTabEditingAllowed, setTabEditingValidator, setTabInsets, setTabLeadingComponent, setTabListCellRenderer, setTabResizeMode, setTabShape, setTabTrailingComponent, setUI, setUseDefaultShowCloseButtonOnTab, setUseDefaultShowIconsOnTab, showTabListPopup, stopTabEditing, updateUI
 - 
Methods inherited from class javax.swing.JTabbedPaneadd, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, getAccessibleContext, getBackgroundAt, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getForegroundAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabComponentAt, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, indexOfTabComponent, isEnabledAt, paramString, remove, remove, removeChangeListener, setBackgroundAt, setDisabledIconAt, setDisplayedMnemonicIndexAt, setEnabledAt, setForegroundAt, setIconAt, setMnemonicAt, setModel, setSelectedComponent, setTabComponentAt, setTabLayoutPolicy, setTabPlacement, setTitleAt, setToolTipTextAt
 - 
Methods inherited from class javax.swing.JComponentaddAncestorListener, 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, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 - 
Methods inherited from class java.awt.ContaineraddContainerListener, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
 - 
Methods inherited from class java.awt.Componentaction, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
- 
 
- 
- 
- 
Field Detail- 
WORKSPACE_KEYpublic static final java.lang.String WORKSPACE_KEY - See Also:
- Constant Field Values
 
 - 
REPORT_DESIGNER_PROPNAMEpublic static final java.lang.String REPORT_DESIGNER_PROPNAME - See Also:
- Constant Field Values
 
 - 
DESIGNER_TOOLBAR_INDEXpublic static final int DESIGNER_TOOLBAR_INDEX - See Also:
- Constant Field Values
 
 - 
DESCRIPTORpublic static final ResourceDescriptor DESCRIPTOR 
 
- 
 - 
Constructor Detail- 
ReportingResourceWorkspacepublic ReportingResourceWorkspace(DesignerContext context) 
 
- 
 - 
Method Detail- 
disposepublic void dispose() Description copied from interface:ResourceWorkspaceCalled when the workspace should be completely disposed.- Specified by:
- disposein interface- ResourceWorkspace
- Overrides:
- disposein class- TabbedResourceWorkspace
 
 - 
createWorkspaceHomeTabprotected java.util.Optional<javax.swing.JComponent> createWorkspaceHomeTab() - Overrides:
- createWorkspaceHomeTabin class- TabbedResourceWorkspace
 
 - 
getDesignerMenupublic DesignerMenu getDesignerMenu() 
 - 
getEditActionHandlerpublic EditActionHandler getEditActionHandler() Description copied from interface:ResourceWorkspaceThe handler that responds to common edit actions, like cut, copy, paste, and delete- Specified by:
- getEditActionHandlerin interface- ResourceWorkspace
- Overrides:
- getEditActionHandlerin class- TabbedResourceWorkspace
 
 - 
getToolbarspublic java.util.List<com.jidesoft.action.CommandBar> getToolbars() Description copied from interface:ResourceWorkspaceReturns the toolbars that will be added when this workspace is active. May be null or empty.- Specified by:
- getToolbarsin interface- ResourceWorkspace
- Overrides:
- getToolbarsin class- TabbedResourceWorkspace
 
 - 
getMenupublic MenuBarMerge getMenu() Description copied from interface:ResourceWorkspaceReturns a menu merge for the menu options that should be present when this workspace is active. May be null.- Specified by:
- getMenuin interface- ResourceWorkspace
- Overrides:
- getMenuin class- TabbedResourceWorkspace
 
 - 
getFramespublic java.util.Collection<ResourceWorkspaceFrame> getFrames() Description copied from interface:ResourceWorkspaceReturns a collection ofResourceWorkspaceFrames that will be associated with this workspace. May be null or empty.- Specified by:
- getFramesin interface- ResourceWorkspace
- Overrides:
- getFramesin class- TabbedResourceWorkspace
 
 - 
getInspectorFramepublic InspectorFrame getInspectorFrame() 
 - 
resetFramespublic void resetFrames(com.jidesoft.docking.DockingManager dockingManager, com.jidesoft.action.DockableBarManager barManager)Description copied from interface:ResourceWorkspaceProgrammatically set the options on the frames and bars that represent the workspace's "defaults"- Specified by:
- resetFramesin interface- ResourceWorkspace
- Overrides:
- resetFramesin class- TabbedResourceWorkspace
 
 - 
getKeypublic java.lang.String getKey() Description copied from interface:ResourceWorkspaceReturns a keyname for the workspace. Used by nav tree nodes to specify which workspace to switch to when they are selected.
 - 
getSelectedEditorpublic ReportingResourceEditor getSelectedEditor() - Overrides:
- getSelectedEditorin class- TabbedResourceWorkspace
 
 - 
addNewResourceActionspublic void addNewResourceActions(ResourceFolderNode folder, javax.swing.JPopupMenu menu) Description copied from class:TabbedResourceWorkspaceThis is where you add the menu items to create new nodes.- Specified by:
- addNewResourceActionsin class- TabbedResourceWorkspace
- See Also:
- NewResourceAction
 
 - 
newResourceEditorprotected ResourceEditor newResourceEditor(ResourcePath id) Description copied from class:TabbedResourceWorkspaceThis is where you create a newResourceEditorfor displaying and editing your resource.- Specified by:
- newResourceEditorin class- TabbedResourceWorkspace
- Parameters:
- id- the id of the resource an editor is being created for
 
 - 
createRootNavTreeNodeprotected AbstractNavTreeNode createRootNavTreeNode() - Overrides:
- createRootNavTreeNodein class- TabbedResourceWorkspace
 
 - 
onDeactivationpublic void onDeactivation() Description copied from interface:ResourceWorkspaceCalled when the resource workspace will be swapped out for a different workspace.- Specified by:
- onDeactivationin interface- ResourceWorkspace
- Overrides:
- onDeactivationin class- TabbedResourceWorkspace
 
 - 
onActivationpublic void onActivation() Description copied from interface:ResourceWorkspaceCalled when the resource workspace will become the active workspace and will be displayed.- Specified by:
- onActivationin interface- ResourceWorkspace
- Overrides:
- onActivationin class- TabbedResourceWorkspace
 
 
- 
 
-