Module wicket.bootstrap.core

Package de.agilecoders.wicket.core.markup.html.bootstrap.button

Class BootstrapButton

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

org.apache.wicket.markup.html.form.FormComponent<String>

org.apache.wicket.markup.html.form.Button

de.agilecoders.wicket.core.markup.html.bootstrap.button.BootstrapButton

All Implemented Interfaces:

IBootstrapButton<BootstrapButton>, Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<String,FormComponent<String>>, IMetadataContext<Serializable,Component>, IFormModelUpdateListener, IFormSubmitter, IFormSubmittingComponent, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

DefaultBootstrapButton, MenuButton

public class BootstrapButton
extends Button
implements IBootstrapButton<BootstrapButton>

A bootstrap styled Button

Author:

miha

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class org.apache.wicket.Component

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

Constructor Summary

Constructors

Constructor	Description
BootstrapButton(String componentId, Buttons.Type type)	Construct.
BootstrapButton(String componentId, IModel<String> model, Buttons.Type type)	Construct.

Method Summary

Modifier and Type	Method	Description
protected Icon	newIcon(String markupId)	creates a new icon component
protected Component	newLabel(String markupId, IModel<String> model)	creates a new label component
protected IMarkupSourcingStrategy	newMarkupSourcingStrategy()
protected Component	newSplitter(String markupId)	creates a new splitter component.
protected void	onConfigure()
protected void	onInitialize()
BootstrapButton	setIconType(IconType iconType)	sets the button's icon which will be rendered in front of the label.
BootstrapButton	setLabel(IModel<String> label)	sets the label of the button.
BootstrapButton	setSize(Buttons.Size size)	sets the size of a button
BootstrapButton	setType(Buttons.Type type)	sets the type of a button
BootstrapButton	useSplitter(boolean value)

Methods inherited from class org.apache.wicket.markup.html.form.Button

getDefaultFormProcessing, getForm, getOnClickScript, initModel, onAfterSubmit, onComponentTag, onComponentTagBody, onError, onSubmit, renderHead, setDefaultFormProcessing, updateModel

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, checkRequired, clearInput, convertInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getInput, getInputAsArray, getInputName, getModelValue, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isFormParticipant, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onBeforeRender, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, updateAutoLabels, updateCollectionModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.markup.html.form.IFormSubmittingComponent

getInputName

Methods inherited from interface org.apache.wicket.IGenericComponent

getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

BootstrapButton

public BootstrapButton(String componentId,
 Buttons.Type type)

Construct.

Parameters:

componentId - The component id

type - The type of the button

BootstrapButton

public BootstrapButton(String componentId,
 IModel<String> model,
 Buttons.Type type)

Construct.

Parameters:

componentId - The component id

model - The label model

type - The type of the button

Method Details

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class MarkupContainer

newIcon

protected Icon newIcon(String markupId)

creates a new icon component

Parameters:

markupId - the component id of the icon

Returns:

new icon component

newLabel

protected Component newLabel(String markupId,
 IModel<String> model)

creates a new label component

Parameters:

markupId - the component id of the label

Returns:

new label component

newSplitter

protected Component newSplitter(String markupId)

creates a new splitter component. The splitter is visible only if icon is visible or if useSplitter is true.

Parameters:

markupId - the component id of the splitter

Returns:

new splitter component

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class Component

newMarkupSourcingStrategy

protected IMarkupSourcingStrategy newMarkupSourcingStrategy()

Overrides:

newMarkupSourcingStrategy in class Component

setLabel

public BootstrapButton setLabel(IModel<String> label)

sets the label of the button.

Overrides:

setLabel in class FormComponent<String>

Parameters:

label - the new button label

Returns:

reference to the current instance

setIconType

public BootstrapButton setIconType(IconType iconType)

sets the button's icon which will be rendered in front of the label.

Parameters:

iconType - the new button icon

Returns:

reference to the current instance

setSize

public BootstrapButton setSize(Buttons.Size size)

Description copied from interface: IBootstrapButton

sets the size of a button

Specified by:

setSize in interface IBootstrapButton<BootstrapButton>

Parameters:

size - The button size to use

Returns:

instance for chaining

setType

public BootstrapButton setType(Buttons.Type type)

Description copied from interface: IBootstrapButton

sets the type of a button

Specified by:

setType in interface IBootstrapButton<BootstrapButton>

Parameters:

type - The button type to use

Returns:

instance for chaining

useSplitter

public BootstrapButton useSplitter(boolean value)

Parameters:

value - whether to use splitter between the icon and the label or not

Returns:

this instance for chaining