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 Summary
Nested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanelNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected org.icepdf.ri.common.SwingControllerprotected Stringprotected intprotected JPanelprotected booleanprotected PropChangeHolder<Integer> static final Dimensionprotected booleanprotected booleanprotected intFields inherited from class AbstractVisionPanel
antialias, context, cursorCode, dynamicPropsFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ComponentLifecycle
COMPONENT_RUNNINGFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface LocaleListener
LOCAL_CHANGE_EVENTFields inherited from interface MutableDynamicPropertyProvider
RESERVED_SET_KEYFields inherited from interface VisionComponent
COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS -
Constructor Summary
Constructors -
Method Summary
Modifier 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 AbstractVisionPanel
getAppContext, 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 JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUIMethods inherited from class 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, updateMethods inherited from class 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, validateTreeMethods inherited from class 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
-
Field Details
-
PREFERRED_SIZE
-
controller
protected org.icepdf.ri.common.SwingController controller -
filePath
-
toolBarVisible
protected boolean toolBarVisible -
utilityPaneVisible
protected boolean utilityPaneVisible -
fitMode
protected int fitMode -
viewMode
protected int viewMode -
pageProp
-
-
Constructor Details
-
PDFViewer
public PDFViewer()
-
-
Method Details
-
onStartup
protected void onStartup()Description copied from class:AbstractVisionPanelSubclasses should override this to provide startup logic.- Overrides:
onStartupin classAbstractVisionPanel
-
onShutdown
protected void onShutdown()Description copied from class:AbstractVisionPanelSubclasses should override this to provide shutdown logic.- Overrides:
onShutdownin classAbstractVisionPanel
-
getController
public org.icepdf.ri.common.SwingController getController() -
getFilePath
-
setFilePath
-
tryOpen
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) -
loadPDFBytes
-
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. -
setPrintMode
Deprecated. -
setPrintingDPI
Deprecated. -
setMouseoverText
Deprecated. -
setBytes
Deprecated. -
setFilename
Deprecated. -
getFilename
-