com.googlecode.wicket.kendo.ui.console

Class AbstractConsole

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.googlecode.wicket.kendo.ui.console.AbstractConsole

All Implemented Interfaces:

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:

Console, FeedbackConsole

public abstract class AbstractConsole
extends org.apache.wicket.markup.html.WebMarkupContainer

Provides the base class for Kendo UI console widget
Note about the capacity: the capacity allows to define a maximum number of messages.
Elder messages will be automatically removed from the model object on insertion.
However, this is only reflected when the component is (re-)rendered (Component.onBeforeRender() has to be invoked)

Author:

Sebastien Briquet - sebfz1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ConsoleBehavior	consoleBehavior

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
AbstractConsole(String id) Constructor with a default capacity (ConsoleMessages.CAPACITY)
AbstractConsole(String id, org.apache.wicket.model.IModel<ConsoleMessages> model) Constructor
AbstractConsole(String id, int capacity) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears console messages
protected String	format(Serializable message, boolean error) Formats the message (escaping, etc)
ConsoleMessages	getModelObject() Gets the model object
void	log(Serializable message, boolean error) Logs a message
void	log(Serializable message, boolean error, org.apache.wicket.ajax.AjaxRequestTarget target) Logs a message
protected ConsoleBehavior	newConsoleBehavior() Gets a new ConsoleBehavior
protected void	onInitialize()

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, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, 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

Field Detail

consoleBehavior

protected ConsoleBehavior consoleBehavior

Constructor Detail

AbstractConsole

public AbstractConsole(String id)

Constructor with a default capacity (ConsoleMessages.CAPACITY)

Parameters:

id - the markup id

AbstractConsole

public AbstractConsole(String id,
               int capacity)

Constructor

Parameters:

id - the markup id

capacity - the max capacity

AbstractConsole

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

Constructor

Parameters:

id - the markup id

model - the ConsoleMessages model

Method Detail

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

getModelObject

public ConsoleMessages getModelObject()

Gets the model object

Returns:

the model object

log

public void log(Serializable message,
       boolean error)

Logs a message

Parameters:

message - the message to log

error - indicates whether the message is an error message

log

public void log(Serializable message,
       boolean error,
       org.apache.wicket.ajax.AjaxRequestTarget target)

Logs a message

Parameters:

message - the message to log

error - indicates whether the message is an error message

target - the AjaxRequestTarget

format

protected String format(Serializable message,
            boolean error)

Formats the message (escaping, etc)

Parameters:

message - the message to format

error - indicates whether the message is an error message

Returns:

the formated message

clear

public void clear()

Clears console messages

newConsoleBehavior

protected ConsoleBehavior newConsoleBehavior()

Gets a new ConsoleBehavior

Returns:

a new ConsoleBehavior