Package com.inductiveautomation.factorypmi.application.components

Class UserManagementPanel

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UserManagementPanel.PySaveContext
      This is available to the user as the saveContext variable passed in on certain extension functions.

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void evaluateEnabled()  
      java.awt.Color getEventForeground()
      Gets the available text color for the ScheduleView contained in this panel This is here for setting this components color via a property.
      java.util.Map<java.lang.String,​ExtensionFunction> getExtensionFunctions()  
      int getMode()  
      int getRowHeight()  
      java.awt.Color getSchedulePreviewAvailableColor()
      Gets the highlight color for the ScheduleView contained in this panel This is here for setting this components color via a property.
      java.awt.Color getTableBackground()
      Gets the table background color for this panel This is here for setting this components color via a property.
      java.awt.Color getTableForeground()
      Gets the text color for the tables in this panel This is here for setting this components color via a property.
      java.awt.Color getTableHeaderBackground()
      Gets the tables' header background color.
      java.awt.Color getTableHeaderTextColor()
      Gets the tables' header text color for the various tables in this panel.
      int getTouchscreenMode()  
      java.lang.String getUsername()  
      java.lang.String getUserProfile()  
      java.awt.Color getWindowBackground()
      Gets the background color for this panel This is here for setting this components color via a property.
      java.awt.Color getWindowForeground()
      Gets the text color for this panel This is here for setting this components color via a property.
      java.awt.Color getWindowHeaderBackground()
      Gets the header background for this panel.
      java.awt.Color getWindowHeaderForeground()
      Gets the header text color for this panel.
      java.awt.Color getWindowHeaderSaveButtonBackground()
      Gets the header save button background for this panel.
      java.awt.Color getWindowHeaderSaveButtonForeground()
      Returns the color of the save button.
      protected void initPanels​(SlidingPane slider)
      Initialize your panels, add at least one to the slider
      boolean isAllowContactInfoEditing()  
      boolean isAllowRoleAssigning()  
      boolean isAllowRoleManagement()  
      boolean isAllowScheduleModifications()  
      boolean isAllowUsernameEditing()  
      boolean isColumnContactInfo()  
      boolean isColumnName()  
      boolean isColumnRoles()  
      boolean isColumnSchedule()  
      boolean isColumnUsername()  
      boolean isComponentEnabled()  
      void localeChanged​(java.util.Locale newLocale)  
      protected void onShutdown()
      Subclasses should override this to provide shutdown logic.
      protected void onStartup()
      Subclasses should override this to provide startup logic.
      void setAllowContactInfoEditing​(boolean allowContactInfoEditing)  
      void setAllowRoleAssigning​(boolean allowRoleAssigning)  
      void setAllowRoleManagement​(boolean allowRoleManagement)  
      void setAllowScheduleModifications​(boolean allowScheduleModifications)  
      void setAllowUsernameEditing​(boolean allowUsernameEditing)  
      void setColumnContactInfo​(boolean columnContactInfo)  
      void setColumnName​(boolean columnName)  
      void setColumnRoles​(boolean columnRoles)  
      void setColumnSchedule​(boolean columnSchedule)  
      void setColumnUsername​(boolean columnUsername)  
      void setComponentEnabled​(boolean componentEnabled)  
      void setEventForeground​(java.awt.Color color)
      Sets the schedule preview available text color contained within the UserManagementPanel.UserEdit.
      void setExtensionFunctions​(java.util.Map<java.lang.String,​ExtensionFunction> map)  
      void setFont​(java.awt.Font font)
      Sets the font of the Manager Panel as well as child components.
      void setMode​(int mode)  
      void setRowHeight​(int height)  
      void setSchedulePreviewAvailableColor​(java.awt.Color color)
      Sets the schedule preview text color contained within UserManagementPanel.UserEdit.
      void setTableBackground​(java.awt.Color color)
      Sets the background to the various tables contained within this panel.
      void setTableForeground​(java.awt.Color color)
      Sets the text color to the various tables contained within this panel.
      void setTableHeaderBackground​(java.awt.Color color)
      Sets the header background to the various tables contained within this panel.
      void setTableHeaderTextColor​(java.awt.Color color)
      Sets the header text color to the various tables contained within this panel.
      void setTouchscreenMode​(int touchscreenMode)  
      void setUsername​(java.lang.String username)  
      void setUserProfile​(java.lang.String userProfile)  
      void setWindowBackground​(java.awt.Color color)
      Sets the background to the various components contained within this panel.
      void setWindowForeground​(java.awt.Color color)
      Sets the text color of the various components contained within this panel.
      void setWindowHeaderBackground​(java.awt.Color color)
      Sets the header background for this panel.
      void setWindowHeaderForeground​(java.awt.Color color)
      Sets the header text color for this panel.
      void setWindowHeaderSaveButtonBackground​(java.awt.Color color)
      Sets the header save button background for this panel.
      void setWindowHeaderSaveButtonForeground​(java.awt.Color color)
      Sets the text color of the save Button's text.
      void updateTables()
      Causes the user table and role tables to update their data

      • 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, 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, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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, 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

      • userProfile

        protected java.lang.String userProfile

      • username

        protected java.lang.String username

    • Constructor Detail

      • UserManagementPanel

        public UserManagementPanel()

    • Method Detail

      • setComponentEnabled

        public void setComponentEnabled​(boolean componentEnabled)
        Specified by:
        setComponentEnabled in interface EnabledEx

      • getRowHeight

        public int getRowHeight()

      • setRowHeight

        public void setRowHeight​(int height)

      • getUserProfile

        public java.lang.String getUserProfile()

      • setUserProfile

        public void setUserProfile​(java.lang.String userProfile)

      • getMode

        public int getMode()

      • setMode

        public void setMode​(int mode)

      • getUsername

        public java.lang.String getUsername()

      • setUsername

        public void setUsername​(java.lang.String username)

      • isColumnUsername

        public boolean isColumnUsername()

      • setColumnUsername

        public void setColumnUsername​(boolean columnUsername)

      • isColumnName

        public boolean isColumnName()

      • setColumnName

        public void setColumnName​(boolean columnName)

      • isColumnRoles

        public boolean isColumnRoles()

      • setColumnRoles

        public void setColumnRoles​(boolean columnRoles)

      • isColumnContactInfo

        public boolean isColumnContactInfo()

      • setColumnContactInfo

        public void setColumnContactInfo​(boolean columnContactInfo)

      • isColumnSchedule

        public boolean isColumnSchedule()

      • setColumnSchedule

        public void setColumnSchedule​(boolean columnSchedule)

      • isAllowRoleManagement

        public boolean isAllowRoleManagement()

      • setAllowRoleManagement

        public void setAllowRoleManagement​(boolean allowRoleManagement)

      • isAllowUsernameEditing

        public boolean isAllowUsernameEditing()

      • setAllowUsernameEditing

        public void setAllowUsernameEditing​(boolean allowUsernameEditing)

      • isAllowRoleAssigning

        public boolean isAllowRoleAssigning()

      • setAllowRoleAssigning

        public void setAllowRoleAssigning​(boolean allowRoleAssigning)

      • isAllowContactInfoEditing

        public boolean isAllowContactInfoEditing()

      • setAllowContactInfoEditing

        public void setAllowContactInfoEditing​(boolean allowContactInfoEditing)

      • isAllowScheduleModifications

        public boolean isAllowScheduleModifications()

      • setAllowScheduleModifications

        public void setAllowScheduleModifications​(boolean allowScheduleModifications)

      • getTouchscreenMode

        public int getTouchscreenMode()

      • setTouchscreenMode

        public void setTouchscreenMode​(int touchscreenMode)

      • updateTables

        public void updateTables()
        Causes the user table and role tables to update their data

      • setWindowBackground

        public void setWindowBackground​(java.awt.Color color)
        Sets the background to the various components contained within this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setWindowForeground

        public void setWindowForeground​(java.awt.Color color)
        Sets the text color of the various components contained within this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setTableBackground

        public void setTableBackground​(java.awt.Color color)
        Sets the background to the various tables contained within this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setTableForeground

        public void setTableForeground​(java.awt.Color color)
        Sets the text color to the various tables contained within this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setTableHeaderBackground

        public void setTableHeaderBackground​(java.awt.Color color)
        Sets the header background to the various tables contained within this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setTableHeaderTextColor

        public void setTableHeaderTextColor​(java.awt.Color color)
        Sets the header text color to the various tables contained within this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setWindowHeaderBackground

        public void setWindowHeaderBackground​(java.awt.Color color)
        Sets the header background for this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setWindowHeaderForeground

        public void setWindowHeaderForeground​(java.awt.Color color)
        Sets the header text color for this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setWindowHeaderSaveButtonForeground

        public void setWindowHeaderSaveButtonForeground​(java.awt.Color color)
        Sets the text color of the save Button's text. This supports colorization via property edit.
        Parameters:
        color - the Color to set the title text to. Must not be null

      • getWindowHeaderSaveButtonForeground

        public java.awt.Color getWindowHeaderSaveButtonForeground()
        Returns the color of the save button.
        Returns:
        the Color of the save button. Will not be null

      • getWindowHeaderForeground

        public java.awt.Color getWindowHeaderForeground()
        Gets the header text color for this panel. This is here for setting this components color via a property.
        Returns:
        the color for the header text. Will not be null

      • getWindowHeaderBackground

        public java.awt.Color getWindowHeaderBackground()
        Gets the header background for this panel. This is here for setting this components color via a property.
        Returns:
        the color for the header background. Will not be null

      • setWindowHeaderSaveButtonBackground

        public void setWindowHeaderSaveButtonBackground​(java.awt.Color color)
        Sets the header save button background for this panel. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • getWindowHeaderSaveButtonBackground

        public java.awt.Color getWindowHeaderSaveButtonBackground()
        Gets the header save button background for this panel. This is here for setting this components color via a property.
        Returns:
        the header save button background color. Will not be null

      • setSchedulePreviewAvailableColor

        public void setSchedulePreviewAvailableColor​(java.awt.Color color)
        Sets the schedule preview text color contained within UserManagementPanel.UserEdit. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • setEventForeground

        public void setEventForeground​(java.awt.Color color)
        Sets the schedule preview available text color contained within the UserManagementPanel.UserEdit. This is here for setting this components color via a property.
        Parameters:
        color - the specified color. Must not be null

      • getTableHeaderTextColor

        public java.awt.Color getTableHeaderTextColor()
        Gets the tables' header text color for the various tables in this panel. This is here for setting this components color via a property.
        Returns:
        the tables' header text color. Will not be null

      • getTableHeaderBackground

        public java.awt.Color getTableHeaderBackground()
        Gets the tables' header background color. This is here for setting this components color via a property.
        Returns:
        the tables' header background color. Will not be null

      • getWindowBackground

        public java.awt.Color getWindowBackground()
        Gets the background color for this panel This is here for setting this components color via a property.
        Returns:
        the panels background color. Will not be null

      • getWindowForeground

        public java.awt.Color getWindowForeground()
        Gets the text color for this panel This is here for setting this components color via a property.
        Returns:
        the panels background color. Will not be null

      • getTableBackground

        public java.awt.Color getTableBackground()
        Gets the table background color for this panel This is here for setting this components color via a property.
        Returns:
        the tables' background color. Will not be null

      • getTableForeground

        public java.awt.Color getTableForeground()
        Gets the text color for the tables in this panel This is here for setting this components color via a property.
        Returns:
        the tables' text color. Will not be null

      • getSchedulePreviewAvailableColor

        public java.awt.Color getSchedulePreviewAvailableColor()
        Gets the highlight color for the ScheduleView contained in this panel This is here for setting this components color via a property.
        Returns:
        the ScheduleView's available highlight color. Will not be null

      • getEventForeground

        public java.awt.Color getEventForeground()
        Gets the available text color for the ScheduleView contained in this panel This is here for setting this components color via a property.
        Returns:
        the ScheduleView's available text color. Will not be null