org.zaproxy.zap.view.panels

Class AbstractContextSelectToolbarStatusPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.parosproxy.paros.extension.AbstractPanel

org.zaproxy.zap.view.panels.AbstractContextSelectToolbarStatusPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Session.OnContextsChangedListener

Direct Known Subclasses:

AbstractScanToolbarStatusPanel

public abstract class AbstractContextSelectToolbarStatusPanel
extends AbstractPanel
implements Session.OnContextsChangedListener

A base implementation for a status panel with a control toolbar that shows information/actions based on a selected Context.

See Also:

unload(), Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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 and Description
protected String	panelPrefix
protected static short	TOOLBAR_LOCATION_AFTER_CONTEXTS_SELECT Location provided to addToolBarElements(JToolBar, short, int) to add items right after the context selection box.
protected static short	TOOLBAR_LOCATION_END Location provided to addToolBarElements(JToolBar, short, int) to add items at the end of the toolbar
protected static short	TOOLBAR_LOCATION_START Location provided to addToolBarElements(JToolBar, short, int) to add items at the beginning of the toolbar.

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
AbstractContextSelectToolbarStatusPanel(String prefix, ImageIcon icon)

Method Summary

Modifier and Type	Method and Description
protected int	addToolBarElements(JToolBar toolBar, short location, int gridX) Adds elements to the tool bar.
void	contextAdded(Context context) Called whenever a new context is created and added.
void	contextDeleted(Context context) Called whenever a new context is deleted.
void	contextsChanged() Called whenever the whole contexts list was changed.
protected void	contextSelected(Context context) Method called whenever a new context is selected.
protected ContextSelectComboBox	getContextSelectComboBox() Gets the Context select combo box.
protected JButton	getOptionsButton() Gets the options button.
Context	getSelectedContext() Gets the selected context.
protected abstract Component	getWorkPanel() Called in order to build the main panel displayed below the toolbar.
protected boolean	hasOptions() Called during initialization to check whether an Options button should be added to the toolbar or not.
protected void	setupToolbarElements(JToolBar toolbar) Method used to setup the toolbar elements.
protected abstract void	switchViewForContext(Context context) Called in order to switch the data displayed on the main panel below the toolbar for a new context.
void	unload() Unloads the status panel.

Methods inherited from class org.parosproxy.paros.extension.AbstractPanel

getDefaultAccelerator, getIcon, getMnemonic, getTabIndex, isHideable, isLocked, isPinned, isShowByDefault, isTabVisible, setDefaultAccelerator, setHideable, setIcon, setLocked, setMnemonic, setParent, setPinned, setShowByDefault, setTabFocus, setTabIndex, tabSelected

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

TOOLBAR_LOCATION_START

protected static final short TOOLBAR_LOCATION_START

Location provided to addToolBarElements(JToolBar, short, int) to add items at the beginning of the toolbar.

See Also:

Constant Field Values

TOOLBAR_LOCATION_AFTER_CONTEXTS_SELECT

protected static final short TOOLBAR_LOCATION_AFTER_CONTEXTS_SELECT

Location provided to addToolBarElements(JToolBar, short, int) to add items right after the context selection box.

See Also:

Constant Field Values

TOOLBAR_LOCATION_END

protected static final short TOOLBAR_LOCATION_END

Location provided to addToolBarElements(JToolBar, short, int) to add items at the end of the toolbar

See Also:

Constant Field Values

panelPrefix

protected String panelPrefix

Constructor Detail

AbstractContextSelectToolbarStatusPanel

public AbstractContextSelectToolbarStatusPanel(String prefix,
                                               ImageIcon icon)

Method Detail

setupToolbarElements

protected void setupToolbarElements(JToolBar toolbar)

Method used to setup the toolbar elements. Should not usually be overridden. Instead, use the addToolBarElements(JToolBar, short, int) method to add elements at various points.

Parameters:

toolbar - the tool bar of the status panel

getOptionsButton

protected JButton getOptionsButton()

Gets the options button.

Returns:

the options button

getContextSelectComboBox

protected ContextSelectComboBox getContextSelectComboBox()

Gets the Context select combo box.

Returns:

the context select combo box

addToolBarElements

protected int addToolBarElements(JToolBar toolBar,
                                 short location,
                                 int gridX)

Adds elements to the tool bar. The method is called while initializing the StatusPanel, at some specific points (TOOLBAR_LOCATION_* constants):

• TOOLBAR_LOCATION_START
• TOOLBAR_LOCATION_AFTER_CONTEXTS_SELECT
• TOOLBAR_LOCATION_END
• other TOOLBAR_LOCATION_* constants defined in extending classes (if case)

Should be overridden by all subclasses that want to add new elements to the ScanPanel's tool bar.

The tool bar uses a GridBagLayout, so elements have to be added with a GridBagConstraints. For this, the LayoutHelper.getGBC(int, int, int, double) methods can be used. The gridX parameter specifies the cell (as used in GridBagConstraints.gridx) of the current row where the elements can be added.

The method must return the new coordinates of the current cell, after the elements have been added.

Parameters:

toolBar - the tool bar

location - the current location where elements will be added

gridX - the x coordinates of the current cell in the GridBagLayout

Returns:

the new coordinates of the current cell, after the elements have been added.

See Also:

LayoutHelper, GridBagConstraints, GridBagLayout

contextSelected

protected void contextSelected(Context context)

Method called whenever a new context is selected.

Parameters:

context - the context that was selected

getSelectedContext

public Context getSelectedContext()

Gets the selected context.

Returns:

the selected context

contextAdded

public void contextAdded(Context context)

Description copied from interface: Session.OnContextsChangedListener

Called whenever a new context is created and added.

Specified by:

contextAdded in interface Session.OnContextsChangedListener

contextDeleted

public void contextDeleted(Context context)

Description copied from interface: Session.OnContextsChangedListener

Called whenever a new context is deleted.

Specified by:

contextDeleted in interface Session.OnContextsChangedListener

contextsChanged

public void contextsChanged()

Description copied from interface: Session.OnContextsChangedListener

Called whenever the whole contexts list was changed.

Specified by:

contextsChanged in interface Session.OnContextsChangedListener

unload

public void unload()

Unloads the status panel.

This method should be called once the panel is no longer needed, to detach it from core (persistent) classes.

Since:

2.7.0

hasOptions

protected boolean hasOptions()

Called during initialization to check whether an Options button should be added to the toolbar or not. Implementations can override this method to remove the default Options button.

Returns:

true if the tool bar should show an Options button, false otherwise

getWorkPanel

protected abstract Component getWorkPanel()

Called in order to build the main panel displayed below the toolbar.

Returns:

the main panel

switchViewForContext

protected abstract void switchViewForContext(Context context)

Called in order to switch the data displayed on the main panel below the toolbar for a new context.

NOTE: Should not recreate a new work panel, but change the existing one (obtained through the first call to getWorkPanel()) to show the new data (e.g. change the DataModel for a table).

Parameters:

context - the context for which to display the panel