com.databasesandlife.util.wicket

Class MultilineLabelWithClickableLinks

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.markup.html.WebComponent

org.apache.wicket.markup.html.basic.Label

com.databasesandlife.util.wicket.MultilineLabelWithClickableLinks

All Implemented Interfaces:

Serializable, 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 MultilineLabelWithClickableLinks
extends org.apache.wicket.markup.html.basic.Label

Displays the text in the model over multiple HTML lines, and makes links clickable.

Author:

This source is copyright Adrian Smith and licensed under the LGPL 3.

See Also:

Project on GitHub, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	linkPattern Matches "foo://foo.foo/foo".

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

Constructor Summary

Constructors

Constructor and Description
MultilineLabelWithClickableLinks(String id, org.apache.wicket.model.IModel<?> model)
MultilineLabelWithClickableLinks(String id, Serializable label)

Method Summary

Modifier and Type	Method and Description
static CharSequence	encodeLinksToHtml(CharSequence plainText) Takes some plain text and returns HTML with URLs marked up as clickable links.
void	onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)

Methods inherited from class org.apache.wicket.markup.html.basic.Label

onComponentTag

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession, onRender

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, get, 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, internalInitialize, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, toString, toString, 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

Field Detail

linkPattern

protected static final Pattern linkPattern

Matches "foo://foo.foo/foo".

• Protocol is optional
• Domain must contain at least one dot (TLD list is too long for whitelist)
• Last part is optional and can contain anything apart from space and trailing punctuation (= part of the sentence in which the link is embedded)

Quotes are not allowed because we don't want <a href="foo"> to have foo containing quotes (XSS).

Constructor Detail

MultilineLabelWithClickableLinks

public MultilineLabelWithClickableLinks(String id,
                                        Serializable label)

MultilineLabelWithClickableLinks

public MultilineLabelWithClickableLinks(String id,
                                        org.apache.wicket.model.IModel<?> model)

Method Detail

encodeLinksToHtml

public static CharSequence encodeLinksToHtml(CharSequence plainText)

Takes some plain text and returns HTML with URLs marked up as clickable links.

Making links clickable is not as easy as it seems.

• Conversion from plain text to HTML requires that entities such as "&" get replaced by "&amp;".
• Links such as "foo.com/a&b" need to get replaced by "<a href='foo.com/a&b'>foo.com/a&amp;b</a>".

Therefore,

• One cannot firstly replace entities and then markup links, as the links should contain unescaped "&" as opposed to "&amp;".
• One cannot firstly encode links and then replace entities as the angle brackets in the link's "<a href.." would get replaced by "&lt;a href..." which the browser would not understand.

Therefore, the replacement of HTML entities, and the replacement of links, must be done in a single pass, not one after another.

Parameters:

plainText - Plain text, no HTML.

Returns:

Safe HTML with entities encoded and links marked up.

onComponentTagBody

public void onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream,
                               org.apache.wicket.markup.ComponentTag openTag)

Overrides:

onComponentTagBody in class org.apache.wicket.markup.html.basic.Label