RMDocumentTool

java.lang.Object
- com.inductiveautomation.snap.ui.UIOwner<SwingEvent,javax.swing.JComponent>
- - com.inductiveautomation.snap.swing.SwingOwner
  - - com.inductiveautomation.rm.tool.RMTool<T>
    - - com.inductiveautomation.rm.tool.RMDocumentTool<T>

public class RMDocumentTool<T extends RMDocument>
extends RMTool<T>

This class provides UI for configuring an RMDocument.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RMDocumentTool.PageSizeView
An inner class to render Page control.
- Nested classes/interfaces inherited from class com.inductiveautomation.rm.tool.RMTool
  RMTool.RMShapeHandle

Field Summary
- Fields inherited from class com.inductiveautomation.rm.tool.RMTool
  HandleE, HandleN, HandleNE, HandleNW, HandleS, HandleSE, HandleSW, HandleW, HandleWidth, SPLIT_RESET
- 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

RMDocumentTool()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getHandleCount(T aShape)`	Overrides tool method to declare that documents have no handles.
`java.lang.Class`	`getShapeClass()`	Returns the class that tool edits.
`java.lang.String`	`getWindowTitle()`	Returns the name to be show in inspector window.
`protected void`	`initUI()`	Initialize UI panel.
`void`	`resetUI()`	Resets the UI controls from the current document.
`void`	`respondUI(SwingEvent anEvent)`	Responds to controls in UI to update current document.

Methods inherited from class com.inductiveautomation.rm.tool.RMTool
acceptsDrag, activateTool, attachEventBus, createUI, deactivateTool, didBecomeSuperSelectedShapeInEditor, dragEnter, dragExit, dragOver, drop, dropClass, dropColor, dropDragKey, dropFiles, dropString, flavorForClass, flushChanges, getAcceptsChildren, getBoundsSuperSelected, getDatasetEntity, getDragDisplayBounds, getEditor, getEditorPane, getFont, getFontDeep, getGalleryClone, getHandleAtPoint, getHandleCursor, getHandleOpposing, getHandlePoint, getHandleRect, getIcon, getIcon, getPointsFromUnits, getSelectedShape, getSelectedShapes, getSelectTool, getShapeFillInspector, getShapeHandleAtPoint, getTool, getTool, getToolTipText, getUnitsFromPoints, isSelected, isSuperSelectable, isSuperSelected, isUngroupable, mouseDragged, mouseDragged, mouseMoved, mouseMoved, mousePressed, mousePressed, mousePressedSelection, mouseReleased, mouseReleased, moveShapeHandle, newInstance, paintShapeHandles, paintTool, processKeyEvent, reactivateTool, setFont, setFontBold, setFontBoldDeep, setFontFamily, setFontFamilyDeep, setFontItalic, setFontItalicDeep, setFontName, setFontNameDeep, setFontSize, setFontSizeDeep, willLoseSuperSelectionInEditor

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
  - RMDocumentTool
```
public RMDocumentTool()
```
- Method Detail
  - getShapeClass
```
public java.lang.Class getShapeClass()
```
    Returns the class that tool edits.
    
    Overrides:
    
    getShapeClass in class RMTool<T extends RMDocument>
  - getWindowTitle
```
public java.lang.String getWindowTitle()
```
    Returns the name to be show in inspector window.
    
    Overrides:
    
    getWindowTitle in class RMTool<T extends RMDocument>
  - initUI
```
protected void initUI()
```
    Initialize UI panel.
    
    Overrides:
    
    initUI in class UIOwner<SwingEvent,javax.swing.JComponent>
  - resetUI
```
public void resetUI()
```
    Resets the UI controls from the current document.
    
    Overrides:
    
    resetUI in class UIOwner<SwingEvent,javax.swing.JComponent>
  - respondUI
```
public void respondUI(SwingEvent anEvent)
```
    Responds to controls in UI to update current document.
    
    Overrides:
    
    respondUI in class UIOwner<SwingEvent,javax.swing.JComponent>
  - getHandleCount
```
public int getHandleCount(T aShape)
```
    Overrides tool method to declare that documents have no handles.
    
    Overrides:
    
    getHandleCount in class RMTool<T extends RMDocument>