com.inductiveautomation.reporting.designer.workspace.design

Class DesignerPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.reporting.designer.workspace.design.AbstractEditorPanel

com.inductiveautomation.reporting.designer.workspace.design.DesignerPanel

All Implemented Interfaces:

ZoomableResourceEditor, ReportingResourceEditor.ReportSubEditor, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class DesignerPanel
extends AbstractEditorPanel
implements ReportingResourceEditor.ReportSubEditor, ZoomableResourceEditor

The DesignerPanel allows a user to design the layout and appearance of a Report by utilizing the ReportMill engine. The panel is made visible by the ReportingResourceEditor when the ReportDesignNode is selected in the Project Resource nav tree, and is dependent on ReportMill's launcher.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.reporting.designer.workspace.design.AbstractEditorPanel

AbstractEditorPanel.LoadingPane

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADD_DECIMAL_TOOL
static java.lang.String	ALIGN_JUSTIFIED
static java.lang.String	ALIGN_TEXT_CENTER
static java.lang.String	ALIGN_TEXT_LEFT
static java.lang.String	ALIGN_TEXT_RIGHT
static java.lang.String	BOLD_FONT_TOOL
static java.lang.String	COMMA_FORMAT_TOOL
static java.lang.String	EDITOR_SELECTION_PROP
static java.lang.String	GROW_FONT_SIZE
static java.lang.String	ITALIC_FONT_TOOL
static java.lang.String	MONEY_FORMAT_TOOL
static java.lang.String	PERCENT_FORMAT_TOOL
static java.lang.String	REDUCE_FONT_SIZE
static java.lang.String	REMOVE_DECIMAL_TOOL
static boolean	showReportMillInspector
static java.lang.String	UNDERLINE_FONT_TOOL
java.beans.PropertyChangeListener	zoomListener

Fields inherited from class com.inductiveautomation.reporting.designer.workspace.design.AbstractEditorPanel

contentPanel, loading

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DesignerPanel(ReportingResourceWorkspace workspace, SampleData sampleData, ReportResource report)

Method Summary

Modifier and Type	Method and Description
void	activateRMTool(java.lang.String toolKey)
void	commitChanges(ReportResource report) This is when the report sub editor should store its settings onto the report object
static void	doRMCopy()
static void	doRMCut()
static void	doRMDelete()
static void	doRMPaste()
void	fitViewerToScreen()
int	getZoom()
ZoomIndicator	getZoomIndicator()
static boolean	isRMItemSelected()
boolean	isZoomingEnabled() Whether or not this resource workspace supports or allows zooming.
void	onActivate() This notifies the editor that it has been displayed
void	onDeactivate() This notifies the editor that it has been hidden
void	setZoom(int percent) Set the amount of zoom for the given resource, where 100 represents 100% sizing

Methods inherited from class com.inductiveautomation.reporting.designer.workspace.design.AbstractEditorPanel

getSharedEditorPane, load, updateErrors

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.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, validateTree

Methods inherited from class java.awt.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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

EDITOR_SELECTION_PROP

public static final java.lang.String EDITOR_SELECTION_PROP

See Also:

Constant Field Values

showReportMillInspector

public static boolean showReportMillInspector

MONEY_FORMAT_TOOL

public static final java.lang.String MONEY_FORMAT_TOOL

See Also:

Constant Field Values

PERCENT_FORMAT_TOOL

public static final java.lang.String PERCENT_FORMAT_TOOL

See Also:

Constant Field Values

COMMA_FORMAT_TOOL

public static final java.lang.String COMMA_FORMAT_TOOL

See Also:

Constant Field Values

ADD_DECIMAL_TOOL

public static final java.lang.String ADD_DECIMAL_TOOL

See Also:

Constant Field Values

REMOVE_DECIMAL_TOOL

public static final java.lang.String REMOVE_DECIMAL_TOOL

See Also:

Constant Field Values

BOLD_FONT_TOOL

public static final java.lang.String BOLD_FONT_TOOL

See Also:

Constant Field Values

UNDERLINE_FONT_TOOL

public static final java.lang.String UNDERLINE_FONT_TOOL

See Also:

Constant Field Values

ITALIC_FONT_TOOL

public static final java.lang.String ITALIC_FONT_TOOL

See Also:

Constant Field Values

ALIGN_TEXT_LEFT

public static final java.lang.String ALIGN_TEXT_LEFT

See Also:

Constant Field Values

ALIGN_TEXT_RIGHT

public static final java.lang.String ALIGN_TEXT_RIGHT

See Also:

Constant Field Values

ALIGN_TEXT_CENTER

public static final java.lang.String ALIGN_TEXT_CENTER

See Also:

Constant Field Values

ALIGN_JUSTIFIED

public static final java.lang.String ALIGN_JUSTIFIED

See Also:

Constant Field Values

REDUCE_FONT_SIZE

public static final java.lang.String REDUCE_FONT_SIZE

See Also:

Constant Field Values

GROW_FONT_SIZE

public static final java.lang.String GROW_FONT_SIZE

See Also:

Constant Field Values

zoomListener

public java.beans.PropertyChangeListener zoomListener

Constructor Detail

DesignerPanel

public DesignerPanel(ReportingResourceWorkspace workspace,
                     SampleData sampleData,
                     ReportResource report)

Method Detail

doRMCopy

public static void doRMCopy()

doRMCut

public static void doRMCut()

doRMPaste

public static void doRMPaste()

doRMDelete

public static void doRMDelete()

isRMItemSelected

public static boolean isRMItemSelected()

onActivate

public void onActivate()

Description copied from interface: ReportingResourceEditor.ReportSubEditor

This notifies the editor that it has been displayed

Specified by:

onActivate in interface ReportingResourceEditor.ReportSubEditor

onDeactivate

public void onDeactivate()

Description copied from interface: ReportingResourceEditor.ReportSubEditor

This notifies the editor that it has been hidden

Specified by:

onDeactivate in interface ReportingResourceEditor.ReportSubEditor

commitChanges

public void commitChanges(ReportResource report)

Description copied from interface: ReportingResourceEditor.ReportSubEditor

This is when the report sub editor should store its settings onto the report object

Specified by:

commitChanges in interface ReportingResourceEditor.ReportSubEditor

activateRMTool

public void activateRMTool(java.lang.String toolKey)

setZoom

public void setZoom(int percent)

Description copied from interface: ZoomableResourceEditor

Set the amount of zoom for the given resource, where 100 represents 100% sizing

Specified by:

setZoom in interface ZoomableResourceEditor

fitViewerToScreen

public void fitViewerToScreen()

getZoom

public int getZoom()

Specified by:

getZoom in interface ZoomableResourceEditor

Returns:

the current zoom level as a percent

isZoomingEnabled

public boolean isZoomingEnabled()

Description copied from interface: ZoomableResourceEditor

Whether or not this resource workspace supports or allows zooming. Returning false will disable the southern toolbar display in the Ignition Designer

Specified by:

isZoomingEnabled in interface ZoomableResourceEditor

Returns:

whether or not the popup menu should be enabled for the given editor

getZoomIndicator

public ZoomIndicator getZoomIndicator()