Class PDFViewer
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanel
com.inductiveautomation.factorypmi.plugins.reporting.components.PDFViewer
- All Implemented Interfaces:
- DynamicPropertyProvider,- LocaleListener,- MutableDynamicPropertyProvider,- StyleProvider,- ComponentLifecycle,- QualityMonitor,- VisionComponent,- ImageObserver,- MenuContainer,- Serializable,- Accessible
- Direct Known Subclasses:
- ICEPDFViewer
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from class javax.swing.JPanelJPanel.AccessibleJPanelNested classes/interfaces inherited from class javax.swing.JComponentJComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.ContainerContainer.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.ComponentComponent.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected org.icepdf.ri.common.SwingControllerprotected Stringprotected intprotected JPanelprotected booleanprotected PropChangeHolder<Integer>static final Dimensionprotected booleanprotected booleanprotected intFields inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanelantialias, context, cursorCode, dynamicPropsFields inherited from class javax.swing.JComponentlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.ComponentaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycleCOMPONENT_RUNNINGFields inherited from interface java.awt.image.ImageObserverABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListenerLOCAL_CHANGE_EVENTFields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProviderRESERVED_SET_KEYFields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponentCOMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionorg.icepdf.ri.common.SwingControllerDeprecated.intintfloatReturns the current zoom level.booleanbooleanbooleanvoidloadPDFBytes(byte[] pdfBytes, String description) protected voidSubclasses should override this to provide shutdown logic.protected voidSubclasses should override this to provide startup logic.voidprint()Prints the current PDF using a print dialog.voidprint(boolean withDialog) Print the current PDF.voidsetBytes(byte[] bytes) Deprecated.voidsetFilename(String filePath) Deprecated.voidsetFilePath(String filePath) voidsetFooterVisible(boolean visible) voidsetMouseoverText(String txt) Deprecated.voidsetPageFitMode(int newMode) voidsetPageViewMode(int newMode) voidsetPrintingDPI(int dpi) Deprecated.voidsetPrintingMode(int mode) Deprecated.voidsetPrintMode(int mode) Deprecated.voidsetToolBarVisible(boolean show) voidsetUtilityPaneVisible(boolean visible) voidsetZoomFactor(float zoomFactor) Sets the zoom level.booleanAttempts to open a PDF at the given path.Methods inherited from class com.inductiveautomation.vision.api.client.components.model.AbstractVisionPanelgetAppContext, getCursorCode, getDataQuality, getDynamicProps, getProperties, getPropertyValue, getQuality, getStyles, getToolTipText, initStyleListener, isAntialias, isComponentRunning, isPropertyDefined, localeChanged, paintChildren, paintComponent, paintOverlayOverChildren, setAntialias, setCursorCode, setDataQuality, setDynamicProps, setName, setPropertyValue, setQuality, setStyles, setToolTipText, setVisible, shutdownComponent, startupComponent, translate, updateQualityMethods inherited from class javax.swing.JPanelgetAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class javax.swing.JComponentaddAncestorListener, 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, updateMethods inherited from class java.awt.Containeradd, 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, validateTreeMethods 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, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
- 
Field Details- 
PREFERRED_SIZE
- 
controllerprotected org.icepdf.ri.common.SwingController controller
- 
filePath
- 
toolBarVisibleprotected boolean toolBarVisible
- 
utilityPaneVisibleprotected boolean utilityPaneVisible
- 
fitModeprotected int fitMode
- 
viewModeprotected int viewMode
- 
pageProp
 
- 
- 
Constructor Details- 
PDFViewerpublic PDFViewer()
 
- 
- 
Method Details- 
onStartupprotected void onStartup()Description copied from class:AbstractVisionPanelSubclasses should override this to provide startup logic.- Overrides:
- onStartupin class- AbstractVisionPanel
 
- 
onShutdownprotected void onShutdown()Description copied from class:AbstractVisionPanelSubclasses should override this to provide shutdown logic.- Overrides:
- onShutdownin class- AbstractVisionPanel
 
- 
getControllerpublic org.icepdf.ri.common.SwingController getController()
- 
getFilePath
- 
setFilePath
- 
tryOpenAttempts to open a PDF at the given path.- Parameters:
- path- the file path or URL of the pdf to be opened
 
- 
isToolBarVisiblepublic boolean isToolBarVisible()
- 
setToolBarVisiblepublic void setToolBarVisible(boolean show) 
- 
isUtilityPaneVisiblepublic boolean isUtilityPaneVisible()
- 
setUtilityPaneVisiblepublic void setUtilityPaneVisible(boolean visible) 
- 
getPageFitModepublic int getPageFitMode()
- 
setPageFitModepublic void setPageFitMode(int newMode) 
- 
getPageViewModepublic int getPageViewMode()
- 
setPageViewModepublic void setPageViewMode(int newMode) 
- 
loadPDFBytes
- 
printpublic void print()Prints the current PDF using a print dialog. Used for scripting
- 
printpublic void print(boolean withDialog) Print the current PDF.- Parameters:
- withDialog- If true, shows the user a print dialog. Used for scripting
 
- 
getZoomFactorpublic float getZoomFactor()Returns the current zoom level. Will return 0 if the component is not initialized yet. Used for scripting- Returns:
- zoomFactor
 
- 
setZoomFactorpublic void setZoomFactor(float zoomFactor) Sets the zoom level. Used for scripting- Parameters:
- zoomFactor- Will be adjusted if outside of documentview's min/max
 
- 
setPrintingModeDeprecated.
- 
setPrintModeDeprecated.
- 
setPrintingDPIDeprecated.
- 
setMouseoverTextDeprecated.
- 
setBytesDeprecated.
- 
setFilenameDeprecated.
- 
getFilenameDeprecated.Use getFilePath instead.
 
-