de.agilecoders.wicket.markup.html.bootstrap.navbar

Class Navbar

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

de.agilecoders.wicket.markup.html.bootstrap.navbar.Navbar

All Implemented Interfaces:

Invertible<Navbar>, 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

public class Navbar
extends org.apache.wicket.markup.html.panel.Panel
implements Invertible<Navbar>

TODO: document

Author:

miha

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Navbar.ComponentPosition indicates the position of a button inside the navigation bar.
static class	Navbar.Position indicates the position of the navigation bar itself

Field Summary

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
Navbar(String componentId) Construct.
Navbar(String componentId, org.apache.wicket.model.IModel<?> model) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
Navbar	addComponents(INavbarComponent... components) adds a component to the given position inside the navbar
Navbar	addComponents(List<INavbarComponent> components) adds a component to the given position inside the navbar
Navbar	brandName(org.apache.wicket.model.IModel<String> brandName) sets the label of the brand name button
Navbar	fluid() marks the navigation to be rendered inside a fluid page layout.
protected Class<? extends org.apache.wicket.Page>	getHomePage()
Navbar.Position	getPosition()
boolean	isFluid()
protected org.apache.wicket.markup.html.image.Image	newBrandImage(String markupId)
protected org.apache.wicket.markup.html.basic.Label	newBrandLabel(String markupId)
protected org.apache.wicket.markup.html.link.BookmarkablePageLink<org.apache.wicket.Page>	newBrandNameLink(String componentId) creates a new brand name button.
protected org.apache.wicket.Component	newNavigation(String componentId, org.apache.wicket.model.IModel<List<org.apache.wicket.Component>> listModel) creates a new navigation list
protected void	onConfigure()
Navbar	setBrandImage(org.apache.wicket.request.resource.ResourceReference imageResourceReference, org.apache.wicket.model.IModel<String> imageAltAttrModel) sets an image in the brand button
Navbar	setInverted(boolean invert) inverts the navbar backgorund color
Navbar	setPosition(Navbar.Position position) Sets the prefered position of the navigation bar on the screen.

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, 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, onComponentTag, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, 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

Constructor Detail

Navbar

public Navbar(String componentId)

Construct.

Parameters:

componentId - The non-null id of this component

Navbar

public Navbar(String componentId,
      org.apache.wicket.model.IModel<?> model)

Construct.

Parameters:

componentId - The non-null id of this component

model - The component's model

Method Detail

newNavigation

protected org.apache.wicket.Component newNavigation(String componentId,
                                        org.apache.wicket.model.IModel<List<org.apache.wicket.Component>> listModel)

creates a new navigation list

Parameters:

componentId - The non-null id of a new navigation component

listModel - The component's model

Returns:

a new navigation list view instance

newBrandNameLink

protected org.apache.wicket.markup.html.link.BookmarkablePageLink<org.apache.wicket.Page> newBrandNameLink(String componentId)

creates a new brand name button.

Parameters:

componentId - The non-null id of a new navigation component

Returns:

a new brand name page link instance

newBrandLabel

protected org.apache.wicket.markup.html.basic.Label newBrandLabel(String markupId)

Parameters:

markupId - The components markup id

Returns:

a new brand name label.

newBrandImage

protected org.apache.wicket.markup.html.image.Image newBrandImage(String markupId)

Parameters:

markupId - The components markup id

Returns:

a new Image

getHomePage

protected Class<? extends org.apache.wicket.Page> getHomePage()

Returns:

the page class which is used for the brand name link. The application's homepage is used by default.

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class org.apache.wicket.Component

getPosition

public Navbar.Position getPosition()

Returns:

true, if the navigation is fixed on the top of the screen.

isFluid

public boolean isFluid()

Returns:

true, if the navigation is rendered for a fluid page layout.

addComponents

public final Navbar addComponents(INavbarComponent... components)

adds a component to the given position inside the navbar

Parameters:

components - the components to add

Returns:

this component instance for chaining

addComponents

public final Navbar addComponents(List<INavbarComponent> components)

adds a component to the given position inside the navbar

Parameters:

components - the components to add

Returns:

this component instance for chaining

brandName

public Navbar brandName(org.apache.wicket.model.IModel<String> brandName)

sets the label of the brand name button

Parameters:

brandName - the brand name label

Returns:

the component's current instance

setBrandImage

public Navbar setBrandImage(org.apache.wicket.request.resource.ResourceReference imageResourceReference,
                   org.apache.wicket.model.IModel<String> imageAltAttrModel)

sets an image in the brand button

Parameters:

imageResourceReference - required

imageAltAttrModel - optional, but should be provided

Returns:

setInverted

public Navbar setInverted(boolean invert)

inverts the navbar backgorund color

Specified by:

setInverted in interface Invertible<Navbar>

Parameters:

invert - whether to invert the color or not

Returns:

the component's current instance

fluid

public Navbar fluid()

marks the navigation to be rendered inside a fluid page layout.

Returns:

the component's current instance.

setPosition

public Navbar setPosition(Navbar.Position position)

Sets the prefered position of the navigation bar on the screen.

Returns:

the component's current instance.