com.googlecode.wicket.jquery.ui.widget.menu

Class ContextMenu

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

com.googlecode.wicket.jquery.core.JQueryPanel

com.googlecode.wicket.jquery.ui.widget.menu.Menu

com.googlecode.wicket.jquery.ui.widget.menu.ContextMenu

All Implemented Interfaces:

IJQueryWidget, java.io.Serializable, java.lang.Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class ContextMenu
extends Menu

Provides a context-menu based on the Menu

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.wicket.jquery.core.IJQueryWidget

IJQueryWidget.JQueryWidget

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXTMENU_CSS_CLASS CSS class used to identify a Menu.

Fields inherited from class com.googlecode.wicket.jquery.core.JQueryPanel

options

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
ContextMenu(java.lang.String id) Constructor
ContextMenu(java.lang.String id, java.util.List<IMenuItem> items) Constructor
ContextMenu(java.lang.String id, java.util.List<IMenuItem> items, Options options) Constructor
ContextMenu(java.lang.String id, Options options) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	getPositionOption(org.apache.wicket.Component component) Gets the jQuery UI position option (as JSON-string) that should be applied on the ContextMenu when 'contextmenu' event is triggered
protected JQueryAbstractBehavior	newContextMenuDocumentBehavior() Gets a new JQueryAbstractBehavior that handles the closing of the context-menu
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag tag)
protected void	onContextMenu(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.Component component) Triggered when 'contextmenu' event is triggered by a component that holds a ContextMenuBehavior
protected void	onInitialize()

Methods inherited from class com.googlecode.wicket.jquery.ui.widget.menu.Menu

getItemList, newWidgetBehavior, onClick

Methods inherited from class com.googlecode.wicket.jquery.core.JQueryPanel

onBeforeRender, onConfigure

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

newMarkupSourcingStrategy

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onConfigure, onDetach, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXTMENU_CSS_CLASS

public static final java.lang.String CONTEXTMENU_CSS_CLASS

CSS class used to identify a Menu. It could be useful to perform some jQuery operation on all menu in the page (hiding for instance)

See Also:

Constant Field Values

Constructor Detail

ContextMenu

public ContextMenu(java.lang.String id)

Constructor

Parameters:

id - the markup id

ContextMenu

public ContextMenu(java.lang.String id,
           java.util.List<IMenuItem> items)

Constructor

Parameters:

id - the markup id

items - the menu-items

ContextMenu

public ContextMenu(java.lang.String id,
           Options options)

Constructor

Parameters:

id - the markup id

options - Options

ContextMenu

public ContextMenu(java.lang.String id,
           java.util.List<IMenuItem> items,
           Options options)

Constructor

Parameters:

id - the markup id

items - the menu-items

options - Options

Method Detail

getPositionOption

protected java.lang.String getPositionOption(org.apache.wicket.Component component)

Gets the jQuery UI position option (as JSON-string) that should be applied on the ContextMenu when 'contextmenu' event is triggered

Parameters:

component - the Component that fired the 'contextmenu' event

Returns:

the jQuery position option (as string)

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class Menu

onComponentTag

protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)

Overrides:

onComponentTag in class org.apache.wicket.Component

onContextMenu

protected void onContextMenu(org.apache.wicket.ajax.AjaxRequestTarget target,
                 org.apache.wicket.Component component)

Triggered when 'contextmenu' event is triggered by a component that holds a ContextMenuBehavior

Parameters:

target - the AjaxRequestTarget

component - the component that holds a ContextMenuBehavior

newContextMenuDocumentBehavior

protected JQueryAbstractBehavior newContextMenuDocumentBehavior()

Gets a new JQueryAbstractBehavior that handles the closing of the context-menu

Returns:

a JQueryAbstractBehavior