Package com.inductiveautomation.factorypmi.plugins.reporting.components

Class PDFViewer

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      PDFViewer()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      org.icepdf.ri.common.SwingController getController()  
      java.lang.String getFilename()
      Deprecated.
      java.lang.String getFilePath()  
      int getPageFitMode()  
      int getPageViewMode()  
      float getZoomFactor()
      Returns the current zoom level.
      boolean isFooterVisible()  
      boolean isToolBarVisible()  
      boolean isUtilityPaneVisible()  
      void loadPDFBytes​(byte[] pdfBytes, java.lang.String description)  
      protected void onShutdown()
      Subclasses should override this to provide shutdown logic.
      protected void onStartup()
      Subclasses should override this to provide startup logic.
      void print()
      Prints the current PDF using a print dialog.
      void print​(boolean withDialog)
      Print the current PDF.
      void setBytes​(byte[] bytes)
      Deprecated.
      void setFilename​(java.lang.String filePath)
      Deprecated.
      void setFilePath​(java.lang.String filePath)  
      void setFooterVisible​(boolean visible)  
      void setMouseoverText​(java.lang.String txt)
      Deprecated.
      void setPageFitMode​(int newMode)  
      void setPageViewMode​(int newMode)  
      void setPrintingDPI​(int dpi)
      Deprecated.
      void setPrintingMode​(int mode)
      Deprecated.
      void setPrintMode​(int mode)
      Deprecated.
      void setToolBarVisible​(boolean show)  
      void setUtilityPaneVisible​(boolean visible)  
      void setZoomFactor​(float zoomFactor)
      Sets the zoom level.
      boolean tryOpen​(java.lang.String path)
      Attempts to open a PDF at the given path.

      • Methods inherited from class javax.swing.JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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, 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

      • PREFERRED_SIZE

        public static final java.awt.Dimension PREFERRED_SIZE

      • controller

        protected org.icepdf.ri.common.SwingController controller

      • filePath

        protected java.lang.String filePath

      • toolBarVisible

        protected boolean toolBarVisible

      • footerVisible

        protected boolean footerVisible

      • utilityPaneVisible

        protected boolean utilityPaneVisible

      • fitMode

        protected int fitMode

      • viewMode

        protected int viewMode

      • footer

        protected javax.swing.JPanel footer

    • Constructor Detail

      • PDFViewer

        public PDFViewer()

    • Method Detail

      • getController

        public org.icepdf.ri.common.SwingController getController()

      • getFilePath

        public java.lang.String getFilePath()

      • setFilePath

        public void setFilePath​(java.lang.String filePath)

      • tryOpen

        public boolean tryOpen​(java.lang.String path)
        Attempts to open a PDF at the given path.
        Parameters:
        path - the file path or URL of the pdf to be opened

      • isToolBarVisible

        public boolean isToolBarVisible()

      • setToolBarVisible

        public void setToolBarVisible​(boolean show)

      • isUtilityPaneVisible

        public boolean isUtilityPaneVisible()

      • setUtilityPaneVisible

        public void setUtilityPaneVisible​(boolean visible)

      • getPageFitMode

        public int getPageFitMode()

      • setPageFitMode

        public void setPageFitMode​(int newMode)

      • getPageViewMode

        public int getPageViewMode()

      • setPageViewMode

        public void setPageViewMode​(int newMode)

      • isFooterVisible

        public boolean isFooterVisible()

      • setFooterVisible

        public void setFooterVisible​(boolean visible)

      • loadPDFBytes

        public void loadPDFBytes​(byte[] pdfBytes,
                         java.lang.String description)

      • print

        public void print()
        Prints the current PDF using a print dialog. Used for scripting

      • print

        public void print​(boolean withDialog)
        Print the current PDF.
        Parameters:
        withDialog - If true, shows the user a print dialog. Used for scripting

      • getZoomFactor

        public float getZoomFactor()
        Returns the current zoom level. Will return 0 if the component is not initialized yet. Used for scripting
        Returns:
        zoomFactor

      • setZoomFactor

        public void setZoomFactor​(float zoomFactor)
        Sets the zoom level. Used for scripting
        Parameters:
        zoomFactor - Will be adjusted if outside of documentview's min/max

      • setPrintingMode

        @Deprecated
public void setPrintingMode​(int mode)
        Deprecated.

      • setPrintMode

        @Deprecated
public void setPrintMode​(int mode)
        Deprecated.

      • setPrintingDPI

        @Deprecated
public void setPrintingDPI​(int dpi)
        Deprecated.

      • setMouseoverText

        @Deprecated
public void setMouseoverText​(java.lang.String txt)
        Deprecated.

      • setBytes

        @Deprecated
public void setBytes​(byte[] bytes)
        Deprecated.

      • setFilename

        @Deprecated
public void setFilename​(java.lang.String filePath)
        Deprecated.

      • getFilename

        @Deprecated
public java.lang.String getFilename()
        Deprecated.
        Use getFilePath instead.