Package com.inductiveautomation.factorypmi.application.components.chart

Class PMIChartPanel

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean antialias  
      protected VisionClientContext context
      The current ClientContext that is set on startupComponent()
      protected int cursorCode  
      protected java.util.Map<java.lang.String,​ExtensionFunction> extensionFunctions  
      protected boolean print  
      protected boolean properties  
      protected boolean save  
      protected boolean showPopup  
      protected boolean zoom  

      • Fields inherited from class org.jfree.chart.ChartPanel

        DEFAULT_BUFFER_USED, DEFAULT_HEIGHT, DEFAULT_MAXIMUM_DRAW_HEIGHT, DEFAULT_MAXIMUM_DRAW_WIDTH, DEFAULT_MINIMUM_DRAW_HEIGHT, DEFAULT_MINIMUM_DRAW_WIDTH, DEFAULT_WIDTH, DEFAULT_ZOOM_TRIGGER_DISTANCE, localizationResources, PRINT_COMMAND, PROPERTIES_COMMAND, SAVE_COMMAND, ZOOM_IN_BOTH_COMMAND, ZOOM_IN_DOMAIN_COMMAND, ZOOM_IN_RANGE_COMMAND, ZOOM_OUT_BOTH_COMMAND, ZOOM_OUT_DOMAIN_COMMAND, ZOOM_OUT_RANGE_COMMAND, ZOOM_RESET_BOTH_COMMAND, ZOOM_RESET_DOMAIN_COMMAND, ZOOM_RESET_RANGE_COMMAND

      • 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 java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

      • Fields inherited from interface java.awt.print.Printable

        NO_SUCH_PAGE, PAGE_EXISTS

    • Constructor Summary

      Constructors 
      Constructor Description
      PMIChartPanel​(org.jfree.chart.JFreeChart chart)  
      PMIChartPanel​(org.jfree.chart.JFreeChart chart, boolean properties, boolean save, boolean print, boolean zoom, boolean tooltips)  
      PMIChartPanel​(org.jfree.chart.JFreeChart chart, boolean properties, boolean save, boolean print, boolean zoom, boolean tooltips, int minimumDrawWidth, int minimumDrawHeight)  
      PMIChartPanel​(org.jfree.chart.JFreeChart chart, int minimumDrawWidth, int minimumDrawHeight)  
      PMIChartPanel​(org.jfree.chart.JFreeChart chart, int width, int height, int minimumDrawWidth, int minimumDrawHeight, int maximumDrawWidth, int maximumDrawHeight, boolean useBuffer, boolean properties, boolean save, boolean print, boolean zoom, boolean tooltips)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void createChartPrintJob()
      Creates a print job for the chart.
      protected javax.swing.JPopupMenu createPopupMenu​(boolean properties, boolean save, boolean print, boolean zoom)
      Creates a popup menu for the panel.
      protected void displayPopupMenu​(int x, int y)
      The idea is to modify the zooming options depending on the type of chart being displayed by the panel.
      void doSaveAs()
      Opens a file chooser and gives the user an opportunity to save the chart in PNG format.
      VisionClientContext getAppContext()  
      int getCursorCode()  
      int getDataQuality()
      For backwards compatibility with scripts.
      java.util.Map<java.lang.String,​ExtensionFunction> getExtensionFunctions()  
      QualityCode getQuality()
      Retrieves the data quality code.
      protected java.text.NumberFormat getScientificNumberFormat()  
      java.lang.String getToolTipText()  
      java.lang.String getToolTipText​(java.awt.event.MouseEvent event)  
      boolean isAntialias()  
      boolean isShowPopup()  
      void localeChanged​(java.util.Locale newLocale)  
      protected void onShutdown()
      Subclasses should override this to provide shutdown logic.
      protected void onStartup()
      Subclasses should override this to provide startup logic.
      protected void paintChildren​(java.awt.Graphics g)  
      void print()  
      void setAntialias​(boolean ignored)  
      void setCursorCode​(int cursorCode)  
      void setDataQuality​(int value)  
      void setExtensionFunctions​(java.util.Map<java.lang.String,​ExtensionFunction> map)  
      void setName​(java.lang.String newName)  
      void setQuality​(QualityCode value)
      Sets the current data quality to the given value
      void setShowPopup​(boolean showPopup)  
      void setVisible​(boolean visible)  
      void shutdownComponent()
      Called when the component is now shown anymore.
      void startupComponent​(VisionClientContext context)
      Called when the component is first shown.
      protected java.lang.String translate​(java.lang.String key)  
      protected java.lang.String translateTerm​(java.lang.String term)  
      void updateQuality​(java.lang.String propName, QualityCode quality)
      Updates the quality for the given property name.

      • Methods inherited from class org.jfree.chart.ChartPanel

        actionPerformed, addChartMouseListener, chartChanged, chartProgress, doEditChartProperties, getAnchor, getChart, getChartRenderingInfo, getDefaultDirectoryForSaveAs, getDismissDelay, getEntityForPoint, getFillZoomRectangle, getHorizontalAxisTrace, getHorizontalTraceLine, getInitialDelay, getListeners, getMaximumDrawHeight, getMaximumDrawWidth, getMinimumDrawHeight, getMinimumDrawWidth, getPopupMenu, getRefreshBuffer, getReshowDelay, getScaleX, getScaleY, getScreenDataArea, getScreenDataArea, getVerticalAxisTrace, getVerticalTraceLine, getZoomAroundAnchor, getZoomInFactor, getZoomOutFactor, getZoomTriggerDistance, isDomainZoomable, isEnforceFileExtensions, isRangeZoomable, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, paintComponent, print, removeChartMouseListener, restoreAutoBounds, restoreAutoDomainBounds, restoreAutoRangeBounds, scale, setAnchor, setChart, setDefaultDirectoryForSaveAs, setDismissDelay, setDisplayToolTips, setDomainZoomable, setEnforceFileExtensions, setFillZoomRectangle, setHorizontalAxisTrace, setHorizontalTraceLine, setInitialDelay, setMaximumDrawHeight, setMaximumDrawWidth, setMinimumDrawHeight, setMinimumDrawWidth, setMouseZoomable, setMouseZoomable, setPopupMenu, setRangeZoomable, setRefreshBuffer, setReshowDelay, setVerticalAxisTrace, setVerticalTraceLine, setZoomAroundAnchor, setZoomInFactor, setZoomOutFactor, setZoomTriggerDistance, translateJava2DToScreen, translateScreenToJava2D, updateUI, zoom, zoomInBoth, zoomInDomain, zoomInRange, zoomOutBoth, zoomOutDomain, zoomOutRange

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI

      • 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, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, 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, setLayout, 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, setComponentOrientation, 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

    • Field Detail

      • context

        protected VisionClientContext context
        The current ClientContext that is set on startupComponent()

      • cursorCode

        protected int cursorCode

      • antialias

        protected boolean antialias

      • extensionFunctions

        protected java.util.Map<java.lang.String,​ExtensionFunction> extensionFunctions

      • properties

        protected boolean properties

      • save

        protected boolean save

      • print

        protected boolean print

      • zoom

        protected boolean zoom

      • showPopup

        protected boolean showPopup

    • Constructor Detail

      • PMIChartPanel

        public PMIChartPanel​(org.jfree.chart.JFreeChart chart)

      • PMIChartPanel

        public PMIChartPanel​(org.jfree.chart.JFreeChart chart,
                     int minimumDrawWidth,
                     int minimumDrawHeight)

      • PMIChartPanel

        public PMIChartPanel​(org.jfree.chart.JFreeChart chart,
                     boolean properties,
                     boolean save,
                     boolean print,
                     boolean zoom,
                     boolean tooltips)

      • PMIChartPanel

        public PMIChartPanel​(org.jfree.chart.JFreeChart chart,
                     boolean properties,
                     boolean save,
                     boolean print,
                     boolean zoom,
                     boolean tooltips,
                     int minimumDrawWidth,
                     int minimumDrawHeight)

      • PMIChartPanel

        public PMIChartPanel​(org.jfree.chart.JFreeChart chart,
                     int width,
                     int height,
                     int minimumDrawWidth,
                     int minimumDrawHeight,
                     int maximumDrawWidth,
                     int maximumDrawHeight,
                     boolean useBuffer,
                     boolean properties,
                     boolean save,
                     boolean print,
                     boolean zoom,
                     boolean tooltips)

    • Method Detail

      • getCursorCode

        public int getCursorCode()

      • setCursorCode

        public void setCursorCode​(int cursorCode)

      • isShowPopup

        public boolean isShowPopup()

      • setShowPopup

        public void setShowPopup​(boolean showPopup)

      • setVisible

        public void setVisible​(boolean visible)
        Overrides:
        setVisible in class javax.swing.JComponent

      • setName

        public void setName​(java.lang.String newName)
        Overrides:
        setName in class java.awt.Component

      • getToolTipText

        public java.lang.String getToolTipText()
        Overrides:
        getToolTipText in class javax.swing.JComponent

      • getToolTipText

        public java.lang.String getToolTipText​(java.awt.event.MouseEvent event)
        Overrides:
        getToolTipText in class org.jfree.chart.ChartPanel

      • isAntialias

        public boolean isAntialias()

      • setAntialias

        public void setAntialias​(boolean ignored)

      • doSaveAs

        public void doSaveAs()
              throws java.io.IOException
        Opens a file chooser and gives the user an opportunity to save the chart in PNG format.
        Overrides:
        doSaveAs in class org.jfree.chart.ChartPanel
        Throws:
        java.io.IOException - if there is an I/O error.

      • print

        public void print()

      • createChartPrintJob

        public void createChartPrintJob()
        Creates a print job for the chart.
        Overrides:
        createChartPrintJob in class org.jfree.chart.ChartPanel

      • translate

        protected java.lang.String translate​(java.lang.String key)

      • translateTerm

        protected java.lang.String translateTerm​(java.lang.String term)

      • createPopupMenu

        protected javax.swing.JPopupMenu createPopupMenu​(boolean properties,
                                                 boolean save,
                                                 boolean print,
                                                 boolean zoom)
        Creates a popup menu for the panel. Overridden here to get the localized properties from BundleUtil.
        Overrides:
        createPopupMenu in class org.jfree.chart.ChartPanel
        Parameters:
        properties - include a menu item for the chart property editor.
        save - include a menu item for saving the chart.
        print - include a menu item for printing the chart.
        zoom - include menu items for zooming.
        Returns:
        The popup menu.

      • getDataQuality

        public int getDataQuality()
        Description copied from interface: QualityMonitor
        For backwards compatibility with scripts. Would be awesome if this could just be a default method, but there's a bug (JDK-8071693) that makes that not work with property introspection.
        Specified by:
        getDataQuality in interface QualityMonitor

      • updateQuality

        public void updateQuality​(java.lang.String propName,
                          QualityCode quality)
        Description copied from interface: QualityMonitor
        Updates the quality for the given property name. The monitor will then evaluate a new quality based on the quality of its other properties. Overall, the worst quality is chosen.
        Specified by:
        updateQuality in interface QualityMonitor

      • paintChildren

        protected void paintChildren​(java.awt.Graphics g)
        Overrides:
        paintChildren in class javax.swing.JComponent

      • shutdownComponent

        public final void shutdownComponent()
        Description copied from interface: ComponentLifecycle
        Called when the component is now shown anymore. Any long-running processes should be stopped. All bindings will have also been shutdown.
        Specified by:
        shutdownComponent in interface ComponentLifecycle

      • onStartup

        protected void onStartup()
        Subclasses should override this to provide startup logic.

      • onShutdown

        protected void onShutdown()
        Subclasses should override this to provide shutdown logic.

      • displayPopupMenu

        protected void displayPopupMenu​(int x,
                                int y)
        The idea is to modify the zooming options depending on the type of chart being displayed by the panel.
        Overrides:
        displayPopupMenu in class org.jfree.chart.ChartPanel
        Parameters:
        x - horizontal position of the popup.
        y - vertical position of the popup.