Package com.inductiveautomation.reporting.designer.workspace.keys

Class AbstractRMDesignerFrame

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.jidesoft.docking.DockableFrame

com.inductiveautomation.reporting.designer.workspace.keys.AbstractRMDesignerFrame

All Implemented Interfaces:

ResourceWorkspaceFrame, com.jidesoft.docking.Dockable, com.jidesoft.docking.DockableHolder, com.jidesoft.docking.Refocusable, com.jidesoft.swing.TabColorProvider, ImageObserver, MenuContainer, Serializable, Accessible, WindowConstants

Direct Known Subclasses:

InspectorFrame, KeysFrame

public abstract class AbstractRMDesignerFrame
extends com.jidesoft.docking.DockableFrame
implements ResourceWorkspaceFrame

A DockableFrame that tracks the reporting workspace's selection, activating a UI only when a report's design tab is visible.

Created by carl.gould on 4/20/2015.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jidesoft.docking.DockableFrame

com.jidesoft.docking.DockableFrame.AccessibleDockableFrame, com.jidesoft.docking.DockableFrame.AutohideAction, com.jidesoft.docking.DockableFrame.CloseAction, com.jidesoft.docking.DockableFrame.DockableAction, com.jidesoft.docking.DockableFrame.FloatingAction, com.jidesoft.docking.DockableFrame.HideAutohideAction, com.jidesoft.docking.DockableFrame.MaximizeAction

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected ReportingResourceEditor	reportResourceEditor
protected final ReportingResourceWorkspace	workspace

Fields inherited from class com.jidesoft.docking.DockableFrame

_autohideAction, _closeAction, _customDoubleClickAction, _dockableAction, _floatingAction, _focusChangeListener, _hideAutohideAction, _maximizeAction, _showContextMenu, AUTOHIDE_ACTION_TO_REMAIN_ACTIVE, BUTTON_ALL, BUTTON_AUTOHIDE, BUTTON_CLOSE, BUTTON_FLOATING, BUTTON_HIDE_AUTOHIDE, BUTTON_MAXIMIZE, CLOSE_ACTION_TO_HIDE, CLOSE_ACTION_TO_REMOVE, CLOSE_ACTION_TO_REMOVE_AND_DISPOSE, ESCAPE_ACTION_DO_NOTING, ESCAPE_ACTION_TO_HIDE, ESCAPE_ACTION_TO_REMOVE, ESCAPE_ACTION_TO_YIELD_FOCUS, PROPERTY_ACTIVE, PROPERTY_ADDITIONAL_BUTTON_ACTIONS, PROPERTY_ADDITONAL_BUTTON_ACTIONS, PROPERTY_AUTOHIDABLE, PROPERTY_AUTOHIDE, PROPERTY_AUTOHIDE_ACTION, PROPERTY_AUTOHIDE_HEIGHT, PROPERTY_AUTOHIDE_SHOWING, PROPERTY_AUTOHIDE_WHEN_ACTIVE, PROPERTY_AUTOHIDE_WIDTH, PROPERTY_AVAILABLE, PROPERTY_AVAILABLE_BUTTONS, PROPERTY_BUTTONS_ORDER, PROPERTY_CLOSE_ACTION, PROPERTY_CONTENT_PANE, PROPERTY_DEFAULT_AUTOHIDE_ACTION, PROPERTY_DEFAULT_CLOSE_ACTION, PROPERTY_DEFAULT_ESCAPE_ACTION, PROPERTY_DOCKABLE, PROPERTY_DOCKABLE_ACTION, PROPERTY_DOCKED, PROPERTY_DOCKED_HEIGHT, PROPERTY_DOCKED_WIDTH, PROPERTY_DOUBLE_CLICK_ACTION, PROPERTY_FLOATABLE, PROPERTY_FLOATED, PROPERTY_FLOATING_ACTION, PROPERTY_FRAME_ICON, PROPERTY_GLASS_PANE, PROPERTY_HIDABLE, PROPERTY_HIDDEN, PROPERTY_HIDE_AUTOHIDE_ACTION, PROPERTY_INIT_INDEX, PROPERTY_INIT_MODE, PROPERTY_INIT_SIDE, PROPERTY_KEY, PROPERTY_LAYERED_PANE, PROPERTY_MAXIMIZABLE, PROPERTY_MAXIMIZE_ACTION, PROPERTY_MAXIMIZED, PROPERTY_MENU_BAR, PROPERTY_PREFERRED_AUTOHIDE_SIDE, PROPERTY_REARRANGABLE, PROPERTY_ROOT_PANE, PROPERTY_SHOW_CONTENT_PANE, PROPERTY_SHOW_CONTEXT_MENU, PROPERTY_SHOW_GRIPPER, PROPERTY_SHOW_TITLE_BAR, PROPERTY_SIDE_DOCK_ALLOWED, PROPERTY_SIDE_TITLE, PROPERTY_SLIDING_AUTOHIDE, PROPERTY_STAY_IN_GROUP, PROPERTY_TAB_DOCK_ALLOWED, PROPERTY_TAB_TITLE, PROPERTY_TITLE, PROPERTY_TITLE_BAR_COMPONENT, PROPERTY_TITLE_LABEL_COMPONENT, PROPERTY_TRANSIENT, PROPERTY_UNDOCKED_BOUNDS, PROPERTY_VISIBLE

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
AbstractRMDesignerFrame(ReportingResourceWorkspace workspace, String dockingKey, Icon icon)

Method Summary

Modifier and Type	Method	Description
ReportResource	getResourceForEditor()
boolean	isInitiallyVisible()	Should this workspace frame be shown initially when the workspace is first selected? Default is true.
protected void	loadEmpty()	Called when the UI should be un-loaded due to design panel becoming inactive, and some empty placeholder should be displayed instead
protected abstract void	loadUI(RMEditor editor)	Called when the editor has changed or displayed after being hidden.

Methods inherited from class com.jidesoft.docking.DockableFrame

addAdditionalButtonActions, addAdditionalButtonActions, addDockableFrameListener, addFocusTracker, addImpl, addNotify, createDockableFrameMouseInputListener, createFocusChangeListener, createFocusTracker, createNotificationFlasher, createNotificationFlasher, createRootPane, deinstallMouseHandlers, dispose, fireDockableFrameEvent, fireDockableFrameEvent, fireDockableFrameEvent, getAccessibleContext, getActionIcon, getAdditionalButtonActions, getAutohideAction, getAutohideHeight, getAutohidePreviousState, getAutohideWidth, getAvailableButtons, getAvailablePreviousState, getButtonsOrder, getCloseAction, getClosePreviousState, getContentPane, getContext, getCustomDoubleClickAction, getDefaultCloseAction, getDefaultEscapeAction, getDefaultFocusComponent, getDockableAction, getDockableFrameListeners, getDockedHeight, getDockedWidth, getDockID, getDockingManager, getDockPreviousState, getDraggingTarget, getFloatingAction, getFloatingAction, getFloatPreviousState, getFocusedComponent, getFocusOwner, getFrameIcon, getGlassPane, getHiddenPreviousState, getHideAutohideAction, getInitIndex, getInitMode, getInitSide, getJMenuBar, getKey, getLayeredPane, getMaximizeAction, getMaximizedPreviousState, getPreferredAutohideSide, getResourceString, getRootPane, getSideTitle, getTabBackground, getTabForeground, getTabTitle, getTitle, getTitleBarComponent, getTitleLabelComponent, getUI, getUIClassID, getUndockedBounds, installMouseHandlers, isActivateAfterSliding, isActive, isAlwaysStayInGroup, isAutohidable, isAutohide, isAutohideShowing, isAutohideWhenActive, isAvailable, isConsideredAsTitleBar, isDockable, isDocked, isDraggingTarget, isFloatable, isFloated, isHidable, isHidden, isMaximizable, isMaximized, isNotified, isOpaque, isRearrangable, isRootPaneCheckingEnabled, isShowContentPane, isShowContextMenu, isShowGripper, isShowTitleBar, isSideDockAllowed, isSlidingAutohide, isTabDockAllowed, isTransient, paramString, remove, removeAdditionalButtonActions, removeDockableFrameListener, removeNotify, requestFocusInInternalWindow, resetDockID, saveAutohidePreviousState, saveAvailablePreviousState, saveClosePreviousState, saveDockPreviousState, saveFloatPreviousState, saveHiddenPreviousState, saveMaximizedPreviousState, setActive, setAlwaysStayInGroup, setAutohidable, setAutohide, setAutohideAction, setAutohideHeight, setAutohidePreviousState, setAutohideShowing, setAutohideWhenActive, setAutohideWidth, setAvailable, setAvailableButtons, setAvailablePreviousState, setButtonsOrder, setCloseAction, setClosePreviousState, setContentPane, setContext, setCustomDoubleClickAction, setDefaultCloseAction, setDefaultEscapeAction, setDefaultFocusComponent, setDockable, setDockableAction, setDocked, setDockedHeight, setDockedWidth, setDockID, setDockingManager, setDockPreviousState, setFloatable, setFloated, setFloatingAction, setFloatPreviousState, setFrameIcon, setGlassPane, setHidable, setHidden, setHiddenPreviousState, setHideAutohideAction, setInitIndex, setInitMode, setInitSide, setJMenuBar, setKey, setLastFocusedComponent, setLayeredPane, setLayout, setMaximizable, setMaximizeAction, setMaximized, setMaximizedPreviousState, setNotified, setPreferredAutohideSide, setPreferredSize, setRearrangable, setRootPane, setRootPaneCheckingEnabled, setShowContentPane, setShowContextMenu, setShowGripper, setShowTitleBar, setSideDockAllowed, setSideTitle, setSlidingAutohide, setTabBackground, setTabDockAllowed, setTabForeground, setTabTitle, setTitle, setTitleBarComponent, setTitleLabelComponent, setTransient, setUI, setUndockedBounds, setVisible, shouldNotify, shouldVetoHiding, shouldVetoRemoving, shouldVetoShowing, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, 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, 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, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, 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

Methods inherited from interface com.inductiveautomation.ignition.designer.model.ResourceWorkspaceFrame

getKey

Field Details

workspace

protected final ReportingResourceWorkspace workspace

reportResourceEditor

protected ReportingResourceEditor reportResourceEditor

Constructor Details

AbstractRMDesignerFrame

public AbstractRMDesignerFrame(ReportingResourceWorkspace workspace,
 String dockingKey,
 Icon icon)

Method Details

loadEmpty

protected void loadEmpty()

Called when the UI should be un-loaded due to design panel becoming inactive, and some empty placeholder should be displayed instead

loadUI

protected abstract void loadUI(RMEditor editor)

Called when the editor has changed or displayed after being hidden.

isInitiallyVisible

public boolean isInitiallyVisible()

Description copied from interface: ResourceWorkspaceFrame

Should this workspace frame be shown initially when the workspace is first selected? Default is true.

Specified by:

isInitiallyVisible in interface ResourceWorkspaceFrame

getResourceForEditor

public ReportResource getResourceForEditor()