Module wicket.bootstrap.core

Package de.agilecoders.wicket.core.markup.html.bootstrap.block

Class Code

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.markup.html.WebComponent

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

de.agilecoders.wicket.core.markup.html.bootstrap.block.Code

All Implemented Interfaces:

Serializable, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class Code
extends Label

#### Description Wrap inline snippets of code with and use

 for multiple
 lines of code. Angle brackets will be escaped in the code for proper rendering.

 #### Usage

 ```java
 Code code = new Code("id", Model.of("content"))
                  .setShowLineNumbers(true) // whether to show line numbers or not
                  .setLanguage(Language.JAVA) // use java as code language; default is dynamic
                  .setStartFromLine(20); // hide first 20 lines
 add(code);
 ```

 ```html
 <code wicket:id="id"></code>
 ```

 It's possible to use `pre`, `code` and `xmp` as tag name.

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

Constructor Summary

Constructors

Constructor	Description
Code(String componentId)	Constructor.
Code(String componentId, IModel<String> model)	Constructor.

Method Summary

Modifier and Type	Method	Description
final boolean	hasLineNumbers()
final Code	setLanguage(CodeBehavior.Language language)	sets the language.
final Code	setShowLineNumbers(boolean showLineNumbers)	adds line numbers on the left side of code block.
final Code	setStartFromLine(int from)	defines from which line number the counting will start.

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

onComponentTag, onComponentTagBody

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

Constructor Details

Code

public Code(String componentId)

Constructor.

Parameters:

componentId - The non-null id of a new component

Code

public Code(String componentId,
 IModel<String> model)

Constructor.

Parameters:

componentId - The non-null id of a new component

model - the component's model

Method Details

hasLineNumbers

public final boolean hasLineNumbers()

Returns:

true, if line numbers will be rendered

setShowLineNumbers

public final Code setShowLineNumbers(boolean showLineNumbers)

adds line numbers on the left side of code block.

Returns:

this instance

setStartFromLine

public final Code setStartFromLine(int from)

defines from which line number the counting will start.

Parameters:

from - which line the numbers will count

Returns:

this instance

setLanguage

public final Code setLanguage(CodeBehavior.Language language)

sets the language.

Parameters:

language - the language to use

Returns:

this instance