Package com.googlecode.wicket.kendo.ui.console

Class AbstractConsole

  • All Implemented Interfaces:
    Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, 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 Description
      protected ConsoleBehavior consoleBehavior  

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler, Serializable message, boolean error)
      Logs a message
      protected ConsoleBehavior newConsoleBehavior()
      Gets a new ConsoleBehavior
      protected void onInitialize()  

      • 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, onComponentTagBody, onDetach, 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, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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

    • 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.MarkupContainer

      • 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​(org.apache.wicket.core.request.handler.IPartialPageRequestHandler handler,
                Serializable message,
                boolean error)
        Logs a message
        Parameters:
        message - the message to log
        error - indicates whether the message is an error message
        handler - the IPartialPageRequestHandler

      • 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