RMEditorPane (ignition 7.9.3 API)

java.lang.Object
- com.inductiveautomation.snap.ui.UIOwner<SwingEvent,javax.swing.JComponent>
- - com.inductiveautomation.snap.swing.SwingOwner
  - - com.inductiveautomation.rm.viewer.RMViewerPane
    - - com.inductiveautomation.rm.editor.RMEditorPane

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener
```
public class RMEditorPane
extends RMViewerPane
```
This class is a container for an RMEditor in an enclosing scroll pane with tool bars for editing.

Nested Class Summary
- Nested classes/interfaces inherited from class com.inductiveautomation.rm.viewer.RMViewerPane
  RMViewerPane.DynamicPopupMenu

Field Summary
- Fields inherited from class com.inductiveautomation.rm.viewer.RMViewerPane
  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 and Description

RMEditorPane()

Constructors
Constructor and Description
`RMEditorPane()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`close()` Closes this editor pane
`protected void`	`closeInspectors()` Called to close inspectors when window is closed.
`RMEditorPaneMenuBar`	`createMenuBar()` Creates the RMEditorPaneMenuBar for the menu bar.
`SwingOwner`	`createTopToolBar()` Creates the top tool bar.
`protected RMViewer`	`createViewer()` Overridden to return an RMEditor.
`protected java.awt.Window`	`createWindowX()` Creates the window.
`void`	`deepChange(java.beans.PropertyChangeListener aShape, java.beans.PropertyChangeEvent anEvent)` Catch Editor DeepChanges to register resetUI.
`protected void`	`editorClosed()` Called when editor is closed.
`AttributesPanel`	`getAttributesPanel()` Returns the editor attributes panel (shared).
`RMDataSource`	`getDataSource()` Returns the datasource associated with the editor's document.
`RMEditor`	`getEditor()` Returns the viewer as an editor.
`java.lang.String`	`getFileDescription()` Returns the description for the editor document for use in open/save panels.
`java.lang.String[]`	`getFileExtensions()` Returns extension for editor document.
`static java.awt.Image`	`getFrameIcon()` Returns the icon for the editor window frame.
`InspectorPanel`	`getInspectorPanel()` Returns the editor inspector (shared).
`static RMEditorPane`	`getMainEditorPane()` Returns the editor pane that is the most recently activated.
`RMEditorPaneMenuBar`	`getMenuBar()` Returns the SwingOwner for the menu bar.
`boolean`	`getShowRulers()` Returns whether editor pane shows rulers.
`RMEditorPaneToolBar`	`getTopToolBar()` Override to return as RMEditorPaneToolBar.
`java.lang.String`	`getWindowTitle()` Returns the window title.
`protected void`	`initUI()` Override to configure Window.
`boolean`	`isEditing()` Returns whether editor is really doing editing.
`void`	`loadPopupMenu(javax.swing.JPopupMenu popupMenu)` Returns a popup menu for the editor.
`RMEditorPane`	`newDocument()` Creates a new default editor pane.
`RMEditorPane`	`open()` Creates a new editor window from an open panel.
`RMEditorPane`	`open(java.lang.Object aSource)` Creates a new editor window by opening the document from the given source.
`void`	`propertyChange(java.beans.PropertyChangeEvent anEvent)` Property change listener to respond to editor chanes.
`void`	`quit()` Called when the app is about to exit to gracefully handle any open documents.
`protected void`	`resetUI()` Updates the editor's UI panels.
`protected void`	`respondUI(SwingEvent anEvent)` Handles changes to the editor's UI controls.
`void`	`revert()` Reloads the current editor document from the last saved version.
`void`	`save()` Saves the current editor document, running the save panel if needed.
`void`	`saveAs()` Saves the current editor document, running the save panel.
`protected void`	`saveImpl()` The real save method.
`void`	`setDataSource(RMDataSource aDataSource)` Sets the datasource for the panel.
`void`	`setDataSource(WebURL aURL, java.awt.geom.Point2D aPoint)` Sets a datasource from a given URL at a given point (if dragged in).
`void`	`setEditing(boolean aFlag)` Sets whether editor is really doing editing.
`void`	`setShowRulers(boolean aValue)` Sets whether editor pane shows rulers.
`protected void`	`setWindowMaximizedBounds()` Returns the suggested maximized bounds for window.
`protected void`	`windowResized()` Window resized notification - if resized within 10 pts of preferred size, snap to preferred size.

Methods inherited from class com.inductiveautomation.rm.viewer.RMViewerPane
addPropertyChangeListener, copy, createBottomToolBar, createUI, getBottomToolBar, getContent, getDocument, getScrollPane, getSourceURL, getViewer, getViewerShape, previewPDF, print, removePropertyChangeListener, setViewer

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, 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

- Constructor Detail
  - RMEditorPane
```
public RMEditorPane()
```
- Method Detail
  - getMainEditorPane
```
public static RMEditorPane getMainEditorPane()
```
    Returns the editor pane that is the most recently activated.
  - getFrameIcon
```
public static java.awt.Image getFrameIcon()
```
    Returns the icon for the editor window frame.
  - getEditor
```
public RMEditor getEditor()
```
    Returns the viewer as an editor.
  - createViewer
```
protected RMViewer createViewer()
```
    Overridden to return an RMEditor.
    
    Overrides:
    
    createViewer in class RMViewerPane
  - getTopToolBar
```
public RMEditorPaneToolBar getTopToolBar()
```
    Override to return as RMEditorPaneToolBar.
    
    Overrides:
    
    getTopToolBar in class RMViewerPane
  - createTopToolBar
```
public SwingOwner createTopToolBar()
```
    Creates the top tool bar.
    
    Overrides:
    
    createTopToolBar in class RMViewerPane
  - getMenuBar
```
public RMEditorPaneMenuBar getMenuBar()
```
    Returns the SwingOwner for the menu bar.
  - createMenuBar
```
public RMEditorPaneMenuBar createMenuBar()
```
    Creates the RMEditorPaneMenuBar for the menu bar.
  - getDataSource
```
public RMDataSource getDataSource()
```
    Returns the datasource associated with the editor's document.
  - setDataSource
```
public void setDataSource(RMDataSource aDataSource)
```
    Sets the datasource for the panel.
  - setDataSource
```
public void setDataSource(WebURL aURL,
                          java.awt.geom.Point2D aPoint)
```
    Sets a datasource from a given URL at a given point (if dragged in).
  - getShowRulers
```
public boolean getShowRulers()
```
    Returns whether editor pane shows rulers.
  - setShowRulers
```
public void setShowRulers(boolean aValue)
```
    Sets whether editor pane shows rulers.
  - isEditing
```
public boolean isEditing()
```
    Returns whether editor is really doing editing.
  - setEditing
```
public void setEditing(boolean aFlag)
```
    Sets whether editor is really doing editing.
  - initUI
```
protected void initUI()
```
    Override to configure Window.
    
    Overrides:
    
    initUI in class UIOwner<SwingEvent,javax.swing.JComponent>
  - resetUI
```
protected void resetUI()
```
    Updates the editor's UI panels.
    
    Overrides:
    
    resetUI in class RMViewerPane
  - respondUI
```
protected void respondUI(SwingEvent anEvent)
```
    Handles changes to the editor's UI controls.
    
    Overrides:
    
    respondUI in class RMViewerPane
  - createWindowX
```
protected java.awt.Window createWindowX()
```
    Creates the window.
  - getInspectorPanel
```
public InspectorPanel getInspectorPanel()
```
    Returns the editor inspector (shared).
  - getAttributesPanel
```
public AttributesPanel getAttributesPanel()
```
    Returns the editor attributes panel (shared).
  - getFileExtensions
```
public java.lang.String[] getFileExtensions()
```
    Returns extension for editor document.
  - getFileDescription
```
public java.lang.String getFileDescription()
```
    Returns the description for the editor document for use in open/save panels.
  - getWindowTitle
```
public java.lang.String getWindowTitle()
```
    Returns the window title.
  - newDocument
```
public RMEditorPane newDocument()
```
    Creates a new default editor pane.
  - open
```
public RMEditorPane open()
```
    Creates a new editor window from an open panel.
  - open
```
public RMEditorPane open(java.lang.Object aSource)
```
    Creates a new editor window by opening the document from the given source.
  - saveAs
```
public void saveAs()
```
    Saves the current editor document, running the save panel.
  - save
```
public void save()
```
    Saves the current editor document, running the save panel if needed.
    
    Overrides:
    
    save in class RMViewerPane
  - saveImpl
```
protected void saveImpl()
                 throws java.lang.Exception
```
    The real save method.
    
    Throws:
    
    java.lang.Exception
  - revert
```
public void revert()
```
    Reloads the current editor document from the last saved version.
  - windowResized
```
protected void windowResized()
```
    Window resized notification - if resized within 10 pts of preferred size, snap to preferred size.
  - setWindowMaximizedBounds
```
protected void setWindowMaximizedBounds()
```
    Returns the suggested maximized bounds for window.
  - close
```
public boolean close()
```
    Closes this editor pane
  - closeInspectors
```
protected void closeInspectors()
```
    Called to close inspectors when window is closed.
  - editorClosed
```
protected void editorClosed()
```
    Called when editor is closed.
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent anEvent)
```
    Property change listener to respond to editor chanes.
    
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
    
    Overrides:
    
    propertyChange in class RMViewerPane
  - deepChange
```
public void deepChange(java.beans.PropertyChangeListener aShape,
                       java.beans.PropertyChangeEvent anEvent)
```
    Catch Editor DeepChanges to register resetUI.
  - quit
```
public void quit()
```
    Called when the app is about to exit to gracefully handle any open documents.
  - loadPopupMenu
```
public void loadPopupMenu(javax.swing.JPopupMenu popupMenu)
```
    Returns a popup menu for the editor.
    
    Overrides:
    
    loadPopupMenu in class RMViewerPane

Class RMEditorPane

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.rm.viewer.RMViewerPane

Field Summary

Fields inherited from class com.inductiveautomation.rm.viewer.RMViewerPane

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

Constructor Summary

Method Summary

Methods inherited from class com.inductiveautomation.rm.viewer.RMViewerPane

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

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

Methods inherited from class java.lang.Object

Constructor Detail

RMEditorPane

Method Detail

getMainEditorPane

getFrameIcon

getEditor

createViewer

getTopToolBar

createTopToolBar

getMenuBar

createMenuBar

getDataSource

setDataSource

setDataSource

getShowRulers

setShowRulers

isEditing

setEditing

initUI

resetUI

respondUI

createWindowX

getInspectorPanel

getAttributesPanel

getFileExtensions

getFileDescription

getWindowTitle

newDocument

open

open

saveAs

save

saveImpl

revert

windowResized

setWindowMaximizedBounds

close

closeInspectors

editorClosed

propertyChange

deepChange

quit

loadPopupMenu