Package org.zaproxy.zap.extension.keyboard

Class ExtensionKeyboard

java.lang.Object

org.parosproxy.paros.extension.ExtensionAdaptor

org.zaproxy.zap.extension.keyboard.ExtensionKeyboard

All Implemented Interfaces:

Extension

public class ExtensionKeyboard
extends ExtensionAdaptor

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor	Description
ExtensionKeyboard()

Method Summary

Modifier and Type	Method	Description
void	displayCheatsheetSortedByAction()
void	displayCheatsheetSortedByKey()
java.lang.String	getAuthor()	Gets the author of the extension.
java.lang.String	getDescription()	Returns the description of the extension, to be shown in UI components.
protected KeyboardParam	getKeyboardParam()
javax.swing.KeyStroke	getShortcut(java.lang.String identifier)
java.util.List<KeyboardShortcut>	getShortcuts()
java.util.List<KeyboardShortcut>	getShortcuts(boolean reset)
java.lang.String	getUIName()	By default returns the name returned by getName().
void	hook(ExtensionHook extensionHook)	Called during extension's initialisation to allow to add new functionality to core components.
void	postInit()	Implement this method to perform tasks after all extensions/add-ons have been initialised.
void	registerMenuItem(ZapMenuItem zme)
void	setShortcut(java.lang.String identifier, javax.swing.KeyStroke ks)
boolean	supportsDb(java.lang.String type)	No database tables used, so all supported

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

canUnload, databaseOpen, destroy, getActiveActions, getAddOn, getDependencies, getExtensionMenu, getExtensionView, getI18nPrefix, getMessages, getModel, getName, getOrder, getUnsavedResources, getView, hasView, init, initModel, initView, initXML, isCore, isDepreciated, isEnabled, optionsLoaded, postInstall, setAddOn, setDescription, setEnabled, setI18nPrefix, setMessages, setName, setOrder, start, stop, supportsLowMemory, unload

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.parosproxy.paros.extension.Extension

getURL, getVersion

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ExtensionKeyboard

public ExtensionKeyboard()

Method Detail

getUIName

public java.lang.String getUIName()

Description copied from class: ExtensionAdaptor

By default returns the name returned by getName().

Specified by:

getUIName in interface Extension

Overrides:

getUIName in class ExtensionAdaptor

Returns:

the UI name of the extension, never null

See Also:

ExtensionAdaptor.getName()

hook

public void hook(ExtensionHook extensionHook)

Description copied from interface: Extension

Called during extension's initialisation to allow to add new functionality to core components.

Specified by:

hook in interface Extension

Overrides:

hook in class ExtensionAdaptor

Parameters:

extensionHook - the hook to add the components.

getKeyboardParam

protected KeyboardParam getKeyboardParam()

postInit

public void postInit()

Description copied from interface: Extension

Implement this method to perform tasks after all extensions/add-ons have been initialised.

Specified by:

postInit in interface Extension

Overrides:

postInit in class ExtensionAdaptor

See Also:

Extension.postInstall()

registerMenuItem

public void registerMenuItem(ZapMenuItem zme)

getShortcuts

public java.util.List<KeyboardShortcut> getShortcuts()

getShortcuts

public java.util.List<KeyboardShortcut> getShortcuts(boolean reset)

getShortcut

public javax.swing.KeyStroke getShortcut(java.lang.String identifier)

setShortcut

public void setShortcut(java.lang.String identifier,
                        javax.swing.KeyStroke ks)

displayCheatsheetSortedByAction

public void displayCheatsheetSortedByAction()

displayCheatsheetSortedByKey

public void displayCheatsheetSortedByKey()

getAuthor

public java.lang.String getAuthor()

Description copied from interface: Extension

Gets the author of the extension.

Since 2.9.0 defaults to the author of the add-on, if set, otherwise an empty string.

Returns:

the author of the extension, might be null.

getDescription

public java.lang.String getDescription()

Description copied from interface: Extension

Returns the description of the extension, to be shown in UI components. The description must be internationalised.

Specified by:

getDescription in interface Extension

Overrides:

getDescription in class ExtensionAdaptor

Returns:

the description of the extension, never null

supportsDb

public boolean supportsDb(java.lang.String type)

No database tables used, so all supported

Specified by:

supportsDb in interface Extension

Overrides:

supportsDb in class ExtensionAdaptor

Parameters:

type - the db type

Returns:

true if the specified db type is supported by the extension (or if it doesn't use any db)

See Also:

Database.getType()