Package com.inductiveautomation.rm.viewer

Class RMViewerPane

java.lang.Object

com.inductiveautomation.snap.ui.UIOwner<SwingEvent,JComponent>

com.inductiveautomation.snap.swing.SwingOwner

com.inductiveautomation.rm.viewer.RMViewerPane

All Implemented Interfaces:

PropertyChangeListener, EventListener

Direct Known Subclasses:

RMEditorPane

public class RMViewerPane
extends SwingOwner
implements PropertyChangeListener

This class is a container for a viewer and tool bars. The default tool bars add document controls (save, print, copy), input controls (select, pan, text select, image select), zoom controls and page controls.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	RMViewerPane.DynamicPopupMenu	A dynamic popup menu class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final PropertyChangeSupport	propertyChangeSupport

Fields inherited from class com.inductiveautomation.snap.ui.UIOwner

DragDrop, DragEnter, DragEvents, DragExit, DragOver, KeyEvents, KeyFinished, KeyPressed, KeyReleased, KeyTyped, MouseClicked, MouseDragged, MouseEntered, MouseEvents, MouseExited, MouseFinished, MouseMoved, MousePressed, MouseReleased

Constructor Summary

Constructors

Constructor	Description
RMViewerPane()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener listener)
void	copy()	Copies the current viewer document selection.
SwingOwner	createBottomToolBar()	Creates bottom tool bar.
SwingOwner	createTopToolBar()	Creates the top tool bar.
protected JComponent	createUI()	Initializes the UI.
protected RMViewer	createViewer()	Creates the real viewer for this viewer plus.
SwingOwner	getBottomToolBar()	Returns the bottom controls.
RMParentShape	getContent()	Returns the content shape.
RMDocument	getDocument()	Returns the RMDocument associated with this viewer.
JScrollPane	getScrollPane()	Returns the scroll pane for this viewer plus.
protected WebURL	getSourceURL()	Returns the document source.
SwingOwner	getTopToolBar()	Returns the top controls.
RMViewer	getViewer()	Returns the viewer for this viewer pane.
RMViewerShape	getViewerShape()	Returns the viewer shape.
protected void	loadPopupMenu(JPopupMenu popupMenu)	Returns a popup menu.
void	previewPDF()	Previews the current viewer document as pdf.
void	print()	Prints the current viewer document.
void	propertyChange(PropertyChangeEvent anEvent)	ResetUI on PropertyChange.
void	removePropertyChangeListener(PropertyChangeListener listener)
protected void	resetUI()	Resets UI.
protected void	respondUI(SwingEvent anEvent)	Respond to UI controls.
void	save()	Saves the current viewer document.
protected void	setViewer(RMViewer aViewer)	Sets the viewer for this viewer pane.

Methods inherited from class com.inductiveautomation.snap.swing.SwingOwner

addKeyActionEvent, createTimer, createUI, createWindow, getNode, getNode, getNodeHelper, getTimer, getTimer, getUI, getWindow, isEventThread, isWindowVisible, requestFocus, requestFocusImpl, runLater, sendEvent, setWindowVisible

Methods inherited from class com.inductiveautomation.snap.ui.UIOwner

addNodeBinding, disableEvents, enableEvents, getBindingModelValue, getBindingNodeValue, getConversionMap, getConversionMapKey, getConversionMaps, getConversionMapValue, getFirstFocus, getModelValue, getNode, getNodeAction, getNodeBoolValue, getNodeFloatValue, getNodeIntValue, getNodeItemDisplayKey, getNodeItems, getNodeSelectedIndex, getNodeSelectedItem, getNodeStringValue, getNodeText, getNodeValue, getUI, getUIHpr, initUI, initUI, isNodeEnabled, isNodeValueAdjusting, isSendEventDisabled, isUISet, processResetUI, processRespondUI, resetLater, resetNodeBindings, runLaterDelayed, runLaterOnce, sendEvent, sendNodeAction, setBindingModelValue, setBindingNodeValue, setFirstFocus, setModelValue, setNodeAction, setNodeEnabled, setNodeItemDisplayKey, setNodeItems, setNodeItems, setNodeSelectedIndex, setNodeSelectedItem, setNodeText, setNodeValue, setSendEventDisabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

propertyChangeSupport

protected final PropertyChangeSupport propertyChangeSupport

Constructor Details

RMViewerPane

public RMViewerPane()

Method Details

createUI

protected JComponent createUI()

Initializes the UI.

Overrides:

createUI in class SwingOwner

getViewer

public RMViewer getViewer()

Returns the viewer for this viewer pane.

setViewer

protected void setViewer(RMViewer aViewer)

Sets the viewer for this viewer pane.

createViewer

protected RMViewer createViewer()

Creates the real viewer for this viewer plus.

getScrollPane

public JScrollPane getScrollPane()

Returns the scroll pane for this viewer plus.

getViewerShape

public RMViewerShape getViewerShape()

Returns the viewer shape.

getContent

public RMParentShape getContent()

Returns the content shape.

getDocument

@Nullable
public RMDocument getDocument()

Returns the RMDocument associated with this viewer.

getSourceURL

protected WebURL getSourceURL()

Returns the document source.

getTopToolBar

public SwingOwner getTopToolBar()

Returns the top controls.

createTopToolBar

public SwingOwner createTopToolBar()

Creates the top tool bar.

getBottomToolBar

public SwingOwner getBottomToolBar()

Returns the bottom controls.

createBottomToolBar

public SwingOwner createBottomToolBar()

Creates bottom tool bar.

save

public void save()

Saves the current viewer document.

print

public void print()

Prints the current viewer document.

Changed in 7.8.0 to catch exception now thrown by getViewer.print

copy

public void copy()

Copies the current viewer document selection.

previewPDF

public void previewPDF()

Previews the current viewer document as pdf.

resetUI

protected void resetUI()

Resets UI.

Overrides:

resetUI in class UIOwner<SwingEvent,JComponent>

respondUI

protected void respondUI(SwingEvent anEvent)

Respond to UI controls.

Overrides:

respondUI in class UIOwner<SwingEvent,JComponent>

propertyChange

public void propertyChange(PropertyChangeEvent anEvent)

ResetUI on PropertyChange.

Specified by:

propertyChange in interface PropertyChangeListener

loadPopupMenu

protected void loadPopupMenu(JPopupMenu popupMenu)

Returns a popup menu.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)