Package org.zaproxy.zap.extension.ascan

Class PolicyAllCategoryPanel

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    public class PolicyAllCategoryPanel
extends AbstractParamPanel
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  PolicyAllCategoryPanel.ScanPolicyChangedEventListener
      The listener interface for receiving notifications of changes in the selected scan policy.

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addScanPolicyChangedEventListener​(PolicyAllCategoryPanel.ScanPolicyChangedEventListener listener)
      Adds the given listener to the list that's notified of each change in the selected scan policy.
      java.lang.String getHelpIndex()
      Gets the index of the help page for this options panel.
      void initialise​(ScanPolicy policy)  
      void initParam​(java.lang.Object obj)
      Initialises the panel with the given data.
      void reloadPolicies()
      Reloads the scan policies, which will pick any new ones that have been defined
      void reloadPolicies​(java.lang.String scanPolicyName)
      Reloads the scan policies, which will pick any new ones that have been defined and selects the policy with the given name.
      void removeScanPolicyChangedEventListener​(PolicyAllCategoryPanel.ScanPolicyChangedEventListener listener)
      Removes the given listener from the list that's notified of each change in the selected scan policy.
      void saveParam​(java.lang.Object obj)
      Saves (the data of) the panel, throwing an exception if there's any error.
      void setScanPolicy​(ScanPolicy scanPolicy)  
      void validateParam​(java.lang.Object obj)
      Validates the panel, throwing an exception if there's any validation error.

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

    • Constructor Detail

      • PolicyAllCategoryPanel

        public PolicyAllCategoryPanel​(java.awt.Window parent,
                              ExtensionActiveScan extension,
                              ScanPolicy policy,
                              boolean switchable)

    • Method Detail

      • initialise

        public void initialise​(ScanPolicy policy)

      • reloadPolicies

        public void reloadPolicies​(java.lang.String scanPolicyName)
        Reloads the scan policies, which will pick any new ones that have been defined and selects the policy with the given name.
        Parameters:
        scanPolicyName - the name of the policy that should be selected
        Since:
        2.5.0

      • reloadPolicies

        public void reloadPolicies()
        Reloads the scan policies, which will pick any new ones that have been defined

      • setScanPolicy

        public void setScanPolicy​(ScanPolicy scanPolicy)

      • initParam

        public void initParam​(java.lang.Object obj)
        Description copied from class: AbstractParamPanel
        Initialises the panel with the given data.
        Specified by:
        initParam in class AbstractParamPanel
        Parameters:
        obj - the object used to initialise the panel and save the data

      • validateParam

        public void validateParam​(java.lang.Object obj)
                   throws java.lang.Exception
        Description copied from class: AbstractParamPanel
        Validates the panel, throwing an exception if there's any validation error.

        The message of the exception is expected to be internationalised (as it might be shown in GUI components, for example, an error dialogue).

        Does nothing by default.

        Overrides:
        validateParam in class AbstractParamPanel
        Parameters:
        obj - the object used to initialise the panel and save the data
        Throws:
        java.lang.Exception - if there's any validation error.

      • saveParam

        public void saveParam​(java.lang.Object obj)
               throws java.lang.Exception
        Description copied from class: AbstractParamPanel
        Saves (the data of) the panel, throwing an exception if there's any error.

        The message of the exception is expected to be internationalised (as it might be shown in GUI components, for example, an error dialogue).

        Specified by:
        saveParam in class AbstractParamPanel
        Parameters:
        obj - the object used to initialise the panel and save the data
        Throws:
        java.lang.Exception - if there's any error while saving the data.

      • getHelpIndex

        public java.lang.String getHelpIndex()
        Description copied from class: AbstractParamPanel
        Gets the index of the help page for this options panel.

        The help index is the value of the target attribute of the corresponding mapID element defined in the JHM file.

        If the help index is provided a button is shown to access the help page.

        Overrides:
        getHelpIndex in class AbstractParamPanel
        Returns:
        the help index, or null if none.

      • addScanPolicyChangedEventListener

        public void addScanPolicyChangedEventListener​(PolicyAllCategoryPanel.ScanPolicyChangedEventListener listener)
        Adds the given listener to the list that's notified of each change in the selected scan policy.
        Parameters:
        listener - the listener that will be added
        Since:
        2.5.0

      • removeScanPolicyChangedEventListener

        public void removeScanPolicyChangedEventListener​(PolicyAllCategoryPanel.ScanPolicyChangedEventListener listener)
        Removes the given listener from the list that's notified of each change in the selected scan policy.
        Parameters:
        listener - the listener that will be removed
        Since:
        2.5.0