Class ContextStructurePanel
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- org.parosproxy.paros.view.AbstractParamPanel
-
- org.zaproxy.zap.view.AbstractContextPropertiesPanel
-
- org.zaproxy.zap.view.ContextStructurePanel
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
public class ContextStructurePanel extends AbstractContextPropertiesPanel
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ContextStructurePanel.DataDrivenNodesMultipleOptionsPanel
static class
ContextStructurePanel.StructuralModifierDialog
-
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
-
-
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
-
-
Constructor Summary
Constructors Constructor Description ContextStructurePanel(Context context)
Constructs aContextStructurePanel
for the given context.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getHelpIndex()
Gets the index of the help page for this options panel.static java.lang.String
getPanelName(int contextId)
Returns the name of the panel "Structure" for the given context index.void
initContextData(Session session, Context context)
Inits the data shown on the panel.void
saveContextData(Session session)
Saves and permanently persists the changes done in the UI.void
saveTemporaryContextData(Context uiSharedContext)
Saves the changes done in the UI into the UI Shared Context, so it is available when other context panels require it.void
validateContextData(Session session)
Validate the context data shown in the UI.-
Methods inherited from class org.zaproxy.zap.view.AbstractContextPropertiesPanel
getContextId, getContextIndex, getUISharedContext, initParam, onHide, saveParam, setSessionDialog, validateParam
-
Methods inherited from class org.parosproxy.paros.view.AbstractParamPanel
onShow, reset
-
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
-
-
-
-
Constructor Detail
-
ContextStructurePanel
public ContextStructurePanel(Context context)
Constructs aContextStructurePanel
for the given context.- Parameters:
context
- the target context, must not benull
.
-
-
Method Detail
-
getPanelName
public static java.lang.String getPanelName(int contextId)
Returns the name of the panel "Structure" for the given context index.- Parameters:
contextId
- the context index that will be used to create the name of the panel- Returns:
- the name of the panel "Include in context" for the given context index
- Since:
- 2.2.0
- See Also:
Context.getId()
-
initContextData
public void initContextData(Session session, Context context)
Description copied from class:AbstractContextPropertiesPanel
Inits the data shown on the panel. This method is the equivalent ofAbstractParamPanel.initParam(Object)
.The
uiSharedContext
parameter provided is a duplicate of the Context to which the panel corresponds and should be used to load any data in the UI and store any changes done in the UI until saving. This Context is shared between all theContext Properties Panels
so any change in one of the panels can be reflected in other panels, if needed. It can also be obtained through calls toAbstractContextPropertiesPanel.getUISharedContext()
- Specified by:
initContextData
in classAbstractContextPropertiesPanel
- Parameters:
session
- the sessioncontext
- the Context shared between the Context Properties Panels
-
validateContextData
public void validateContextData(Session session) throws java.lang.Exception
Description copied from class:AbstractContextPropertiesPanel
Validate the context data shown in the UI. This method is the equivalent ofAbstractParamPanel.validateParam(Object)
.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:
validateContextData
in classAbstractContextPropertiesPanel
- Parameters:
session
- the session- Throws:
java.lang.Exception
- if there's any validation error.
-
saveContextData
public void saveContextData(Session session) throws java.lang.Exception
Description copied from class:AbstractContextPropertiesPanel
Saves and permanently persists the changes done in the UI. This method is the equivalent ofAbstractParamPanel.saveParam(Object)
.- Specified by:
saveContextData
in classAbstractContextPropertiesPanel
- Parameters:
session
- the session- Throws:
java.lang.Exception
- if there's any error while saving the data.
-
saveTemporaryContextData
public void saveTemporaryContextData(Context uiSharedContext)
Description copied from class:AbstractContextPropertiesPanel
Saves the changes done in the UI into the UI Shared Context, so it is available when other context panels require it. Usually, this method is called when the panel is hidden (AbstractContextPropertiesPanel.onHide()
).The @{code uiSharedContext} parameter provided is a duplicate of the Context to which the panel corresponds and should be used to load any data in the UI and store any changes done in the UI until saving. This Context is shared between all the
Context Properties Panels
so any change in one of the panels can be reflected in other panels, if needed.- Specified by:
saveTemporaryContextData
in classAbstractContextPropertiesPanel
- Parameters:
uiSharedContext
- the ui shared context
-
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 correspondingmapID
element defined in the JHM file.If the help index is provided a button is shown to access the help page.
- Overrides:
getHelpIndex
in classAbstractParamPanel
- Returns:
- the help index, or
null
if none.
-
-