at.ebinterface.validation.web.components

Class CodeBox

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.markup.html.WebComponent

at.ebinterface.validation.web.components.CodeBox

All Implemented Interfaces:

Serializable, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, 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 CodeBox
extends org.apache.wicket.markup.html.WebComponent

A code block which does syntax highlighting of the code contents. Wraps the Prettify library by Google http://code.google.com/p/google-code-prettify/

It is not necessary to specify a language, prettify will guess the language based on content, however an override is available should it be required.

Apply to a <pre> or <code>

Version:

$Id: CodeBox.java 261 2011-03-08 20:53:16Z tibes80@gmail.com $

Author:

Richard Nichols

See Also:

Serialized Form

Field Summary

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
CodeBox(String id) Create a Codebox with static content with the given `id`.
CodeBox(String id, org.apache.wicket.model.IModel<?> model) Create a codebox with source code provided by an `IModel` and the given `id`.
CodeBox(String id, String code) Create a Codebox with the provided code content and the given `id`.

Method Summary

Modifier and Type	Method and Description
protected boolean	autoAddToHeader() Override and return false to suppress static JavaScript and CSS contributions.
CodeBoxLanguage	getLanguageOverride()
boolean	isDisplayLineNumbers()
protected void	onComponentTag(org.apache.wicket.markup.ComponentTag tag)
void	onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
CodeBox	setDisplayLineNumbers(boolean displayLineNumbers) Toggle the display of line numbers in the left gutter.
CodeBox	setLanguageOverride(CodeBoxLanguage languageOverride) Override the language used for syntax highlighting.

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

Constructor Detail

CodeBox

public CodeBox(String id)

Create a Codebox with static content with the given `id`.

Parameters:

id - ID

CodeBox

public CodeBox(String id,
               String code)

Create a Codebox with the provided code content and the given `id`.

Parameters:

id - ID

code - source code to display

CodeBox

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

Create a codebox with source code provided by an `IModel` and the given `id`.

Parameters:

id - ID

model - a model that will provide the source code to display

Method Detail

autoAddToHeader

protected boolean autoAddToHeader()

Override and return false to suppress static JavaScript and CSS contributions. (May be desired if you are concatenating / compressing resources as part of build process)

Returns:

true

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component

onComponentTag

protected void onComponentTag(org.apache.wicket.markup.ComponentTag tag)

Overrides:

onComponentTag in class org.apache.wicket.Component

onComponentTagBody

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

Overrides:

onComponentTagBody in class org.apache.wicket.Component

isDisplayLineNumbers

public boolean isDisplayLineNumbers()

setDisplayLineNumbers

public CodeBox setDisplayLineNumbers(boolean displayLineNumbers)

Toggle the display of line numbers in the left gutter.

Parameters:

displayLineNumbers - toggle

Returns:

this

getLanguageOverride

public CodeBoxLanguage getLanguageOverride()

setLanguageOverride

public CodeBox setLanguageOverride(CodeBoxLanguage languageOverride)

Override the language used for syntax highlighting.

Parameters:

languageOverride - language

Returns:

this