org.wicketstuff.chat.components.chat

Class BaseChatPanel

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

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

org.wicketstuff.chat.components.chat.BaseChatPanel

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:

SimpleChatPanel

public abstract class BaseChatPanel
extends org.apache.wicket.markup.html.panel.Panel

The Class BaseChatPanel.

See Also:

Serialized Form

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
BaseChatPanel(String id, org.apache.wicket.model.IModel<ChatroomModel> model) Instantiates a new base chat panel.

Method Summary

Modifier and Type	Method and Description
protected void	addChannelListener(org.apache.wicket.model.IModel<ChatroomModel> model) Adds the channel listener to the channel service.
protected abstract org.wicketstuff.chat.channel.api.IChannelService	getChannelService() Abstract method that subclasses must implement.
org.apache.wicket.Component	getChat() Gets the chat.
org.apache.wicket.markup.html.form.Form<ChatroomModel>	getForm() Gets the form.
org.apache.wicket.markup.html.form.TextField<String>	getMessage() Gets the message.
org.apache.wicket.ajax.markup.html.form.AjaxButton	getSend() Gets the send.
protected org.apache.wicket.Component	newChatLabel(String id) Factory method for creating the Chat component.
protected org.apache.wicket.markup.html.form.Form<ChatroomModel>	newForm(String id, org.apache.wicket.model.IModel<ChatroomModel> model) New form.
protected org.apache.wicket.markup.html.form.TextField<String>	newMessageTextField(String id) Factory method for creating the TextField for the message.
protected org.apache.wicket.ajax.markup.html.form.AjaxButton	newSendAjaxButton(String id, org.apache.wicket.markup.html.form.Form<ChatroomModel> form) Factory method for creating the AjaxButton.

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

newMarkupSourcingStrategy

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

getWebApplication, 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, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BaseChatPanel

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

Instantiates a new base chat panel.

Parameters:

id - the id

model - the model

Method Detail

addChannelListener

protected void addChannelListener(org.apache.wicket.model.IModel<ChatroomModel> model)

Adds the channel listener to the channel service.

Parameters:

model - the model

getChannelService

protected abstract org.wicketstuff.chat.channel.api.IChannelService getChannelService()

Abstract method that subclasses must implement. Gets the channel service. This service should be returned from the application class.

Returns:

the channel service

getChat

public org.apache.wicket.Component getChat()

Gets the chat.

Returns:

the chat

getForm

public org.apache.wicket.markup.html.form.Form<ChatroomModel> getForm()

Gets the form.

Returns:

the form

getMessage

public org.apache.wicket.markup.html.form.TextField<String> getMessage()

Gets the message.

Returns:

the message

getSend

public org.apache.wicket.ajax.markup.html.form.AjaxButton getSend()

Gets the send.

Returns:

the send

newChatLabel

protected org.apache.wicket.Component newChatLabel(String id)

Factory method for creating the Chat component. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a Chat component.

Parameters:

id - the id

Returns:

the label

newForm

protected org.apache.wicket.markup.html.form.Form<ChatroomModel> newForm(String id,
                                                                         org.apache.wicket.model.IModel<ChatroomModel> model)

New form.

Parameters:

id - the id

model - the model

Returns:

the form

newMessageTextField

protected org.apache.wicket.markup.html.form.TextField<String> newMessageTextField(String id)

Factory method for creating the TextField for the message. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of a TextField for the message.

Parameters:

id - the id

Returns:

the text field

newSendAjaxButton

protected org.apache.wicket.ajax.markup.html.form.AjaxButton newSendAjaxButton(String id,
                                                                               org.apache.wicket.markup.html.form.Form<ChatroomModel> form)

Factory method for creating the AjaxButton. This method is invoked in the constructor from the derived classes and can be overridden so users can provide their own version of an AjaxButton.

Parameters:

id - the id

form - the form

Returns:

the ajax button