de.agilecoders.wicket.markup.html.bootstrap.button.dropdown

Class DropDownButton

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.link.AbstractLink

de.agilecoders.wicket.markup.html.bootstrap.button.dropdown.DropDownButton

All Implemented Interfaces:

Activatable, Invertible<DropDownButton>, Serializable, 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

Direct Known Subclasses:

DropDownSubMenu, NavbarDropDownButton, SplitButton

public abstract class DropDownButton
extends org.apache.wicket.markup.html.link.AbstractLink
implements Invertible<DropDownButton>, Activatable

Use any button to trigger a dropdown menu by placing it within a .btn-group and providing the proper menu markup.

Author:

miha

See Also:

Serialized Form

Field Summary

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
DropDownButton(String id, org.apache.wicket.model.IModel<String> model) Construct.
DropDownButton(String markupId, org.apache.wicket.model.IModel<String> model, org.apache.wicket.model.IModel<IconType> iconTypeModel) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addButtonBehavior(org.apache.wicket.model.IModel<Buttons.Type> buttonType, org.apache.wicket.model.IModel<Buttons.Size> buttonSize) adds the button behavior to the base button of this dropdown component
protected void	addIconToBaseButton(Icon icon) adds an icon to the base button
DropDownButton	addToButton(org.apache.wicket.behavior.Behavior behavior) adds a Behavior to the base button
void	appendToggleMenuScript(org.apache.wicket.ajax.AjaxRequestTarget target) appends a toggle menu script to a given AjaxRequestTarget.
protected String	createCssClassName()
org.apache.wicket.Component	getBaseButton() Deprecated.
boolean	isActive(org.apache.wicket.Component item) Decides whether the current instance (this) is the active item.
protected org.apache.wicket.markup.html.WebMarkupContainer	newButton(String markupId, org.apache.wicket.model.IModel<String> labelModel, org.apache.wicket.model.IModel<IconType> iconTypeModel) creates a new button instance
protected Icon	newButtonIcon(String markupId, org.apache.wicket.model.IModel<IconType> iconTypeModel) creates a new icon component with given IconType.
protected org.apache.wicket.Component	newButtonLabel(String markupId, org.apache.wicket.model.IModel<?> labelModel) creates a new icon component with given IconType.
protected String	newInitializerScript()
protected org.apache.wicket.markup.html.panel.IMarkupSourcingStrategy	newMarkupSourcingStrategy()
protected abstract List<org.apache.wicket.markup.html.link.AbstractLink>	newSubMenuButtons(String buttonMarkupId) creates a list of sub menu buttons which will be shown if sub menu will be opened.
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag tag)
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
DropDownButton	setDropUp(boolean dropUp) whether to use default dropdown behavior (default value is false which means default behavior) or to open the dropdown menu at the top of dropdown button, also the button icon will be rotated.
DropDownButton	setIconType(IconType iconType) sets the icon of the base button element
DropDownButton	setInverted(boolean inverted) inverts the ui state of a component.
DropDownButton	setSize(Buttons.Size size) sets the size of the button
DropDownButton	setType(Buttons.Type type) sets the type of the button

Methods inherited from class org.apache.wicket.markup.html.link.AbstractLink

disableLink, getAfterDisabledLink, getBeforeDisabledLink, getBody, isLinkEnabled, onBeforeRender, onComponentTagBody, onDetach, setAfterDisabledLink, setBeforeDisabledLink, setBody

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, 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, 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, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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

Constructor Detail

DropDownButton

public DropDownButton(String id,
              org.apache.wicket.model.IModel<String> model)

Construct.

Parameters:

id - The markup id

model - The label of the main button

DropDownButton

public DropDownButton(String markupId,
              org.apache.wicket.model.IModel<String> model,
              org.apache.wicket.model.IModel<IconType> iconTypeModel)

Construct.

Parameters:

markupId - The markup id

model - The label of the main button

iconTypeModel - the type of the icon

Method Detail

createCssClassName

protected String createCssClassName()

Returns:

base css class name of button container element

addIconToBaseButton

protected void addIconToBaseButton(Icon icon)

adds an icon to the base button

Parameters:

icon - The icon to add

addToButton

public final DropDownButton addToButton(org.apache.wicket.behavior.Behavior behavior)

adds a Behavior to the base button

Parameters:

behavior - to add

Returns:

this instance for chaining

newInitializerScript

protected String newInitializerScript()

Returns:

new initializer script

appendToggleMenuScript

public final void appendToggleMenuScript(org.apache.wicket.ajax.AjaxRequestTarget target)

appends a toggle menu script to a given AjaxRequestTarget.

Parameters:

target - the current target

setIconType

public final DropDownButton setIconType(IconType iconType)

sets the icon of the base button element

Parameters:

iconType - The IconType of the icon

Returns:

this element instance

newButton

protected org.apache.wicket.markup.html.WebMarkupContainer newButton(String markupId,
                                                         org.apache.wicket.model.IModel<String> labelModel,
                                                         org.apache.wicket.model.IModel<IconType> iconTypeModel)

creates a new button instance

Parameters:

markupId - The component's id

labelModel - The label text as model

iconTypeModel - The icon type as model

Returns:

a new button component

newButtonLabel

protected org.apache.wicket.Component newButtonLabel(String markupId,
                                         org.apache.wicket.model.IModel<?> labelModel)

creates a new icon component with given IconType.

Parameters:

markupId - The component' id

labelModel - The label text as model

Returns:

new label component

newButtonIcon

protected Icon newButtonIcon(String markupId,
                 org.apache.wicket.model.IModel<IconType> iconTypeModel)

creates a new icon component with given IconType.

Parameters:

markupId - The component' id

iconTypeModel - The icon type as model

Returns:

new icon component

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component

addButtonBehavior

protected void addButtonBehavior(org.apache.wicket.model.IModel<Buttons.Type> buttonType,
                     org.apache.wicket.model.IModel<Buttons.Size> buttonSize)

adds the button behavior to the base button of this dropdown component

Parameters:

buttonType - mandatory parameter

buttonSize - mandatory parameter

newSubMenuButtons

protected abstract List<org.apache.wicket.markup.html.link.AbstractLink> newSubMenuButtons(String buttonMarkupId)

creates a list of sub menu buttons which will be shown if sub menu will be opened.

Parameters:

buttonMarkupId - the markup id that all sub menu buttons must be use.

Returns:

list of sub menu buttons

setDropUp

public DropDownButton setDropUp(boolean dropUp)

whether to use default dropdown behavior (default value is false which means default behavior) or to open the dropdown menu at the top of dropdown button, also the button icon will be rotated.

Parameters:

dropUp - true, to use a 180deg rotated button and open menu on top

Returns:

this instance for chaining

setSize

public DropDownButton setSize(Buttons.Size size)

sets the size of the button

Parameters:

size - mandatory parameter

Returns:

this instance for chaining

setType

public DropDownButton setType(Buttons.Type type)

sets the type of the button

Parameters:

type - mandatory parameter

Returns:

this instance for chaining

newMarkupSourcingStrategy

protected final org.apache.wicket.markup.html.panel.IMarkupSourcingStrategy newMarkupSourcingStrategy()

Overrides:

newMarkupSourcingStrategy in class org.apache.wicket.Component

onComponentTag

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

Overrides:

onComponentTag in class org.apache.wicket.Component

setInverted

public DropDownButton setInverted(boolean inverted)

Description copied from interface: Invertible

inverts the ui state of a component.

Specified by:

setInverted in interface Invertible<DropDownButton>

Parameters:

inverted - true, if inverted version should be used

Returns:

this instance for chaining

isActive

public boolean isActive(org.apache.wicket.Component item)

Description copied from interface: Activatable

Decides whether the current instance (this) is the active item.

Specified by:

isActive in interface Activatable

Parameters:

item - the current instance as a Component

Returns:

true if the item is the current active one

getBaseButton

@Deprecated
public final org.apache.wicket.Component getBaseButton()

Deprecated.

Returns:

the base button instance