WicketExtendInput (stumps 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.wicket.Component
- - org.apache.wicket.markup.html.WebComponent
  - - org.apache.wicket.markup.html.include.Include
    - - com.neurosys.site.wicket.components.FilterInput
      - com.neurosys.site.wicket.components.WicketExtendInput

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator
```
public class WicketExtendInput
extends FilterInput
```
WicketExtendInput.Include allows import of markup, but they recommend it used for non-wicket based markup.
For situations where we can use the same markup for Wicket or Plain this can be useful to strip out the wicket tags when not needed and include as a regular markup.

The content is worked upon using a Default Transformer

Caution, all tags upto <wicket:extend> are removed (and similarly from below)
If there is a header in the markup between then that can be retrieved using getHeader().
The include parsing is currently case sensitive when it comes to parsing tags like <body>, <wicket:head> & <wicket:extend>

Currently this Input does not support caching, but a wrapper can be put around it that cacehs by sourceName (key) = Model<String>

TODO: use a XML parser or XPath perhaps.

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WicketExtendInput.Include`
`static class`	`WicketExtendInput.SpecialTag` These will parse for their associated regEx and have special significance. The value (determined by the context the special tag is used for), is put in `Map` `#bodyTags`

Nested classes/interfaces inherited from class org.apache.wicket.Component
org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary
- Fields inherited from class org.apache.wicket.Component
  ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors
Constructor and Description
`WicketExtendInput(String id)`
`WicketExtendInput(String id, org.apache.wicket.model.IModel<String> model)`
`WicketExtendInput(String id, String modelObject)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`filter()`
`protected String`	`filter(String markupContent)`
`String`	`getContent()`
`org.apache.commons.collections.Transformer`	`getContentTransformer()` One can override `contentTransformer` with a Chain or another `Transformer`. To use the default `Transformer` in a chain you can refer to `getDefaultContentTransformer()`.
`org.apache.commons.collections.Transformer`	`getDefaultContentTransformer()`
`String`	`getHeader()`
`Map<String,String>`	`getSpecialTags()` {@literal get the Special Tags like tag value.
`WicketExtendInput.Include`	`getType()`
`protected void`	`onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)` This only gets executed during rendering
`protected void`	`parseForSpecialTags(String markupContent)`
`void`	`setContentTransformer(org.apache.commons.collections.Transformer contentTransformer)` One can override `contentTransformer` with a Chain or another `Transformer`. To use the default `Transformer` in a chain you can refer to `getDefaultContentTransformer()`.
`void`	`setType(WicketExtendInput.Include type)`

Methods inherited from class com.neurosys.site.wicket.components.FilterInput
getCharset, importAsString, replaceFilter, setCharset

Methods inherited from class org.apache.wicket.markup.html.include.Include
isAbsolute

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

Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMarkupStream, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, toString, toString, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WicketExtendInput
```
public WicketExtendInput(String id)
```
  - WicketExtendInput
```
public WicketExtendInput(String id,
                         org.apache.wicket.model.IModel<String> model)
```
  - WicketExtendInput
```
public WicketExtendInput(String id,
                         String modelObject)
```
- Method Detail
  - onComponentTagBody
```
protected void onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream,
                                  org.apache.wicket.markup.ComponentTag openTag)
```
    This only gets executed during rendering
    
    Overrides:
    
    onComponentTagBody in class FilterInput
  - filter
```
public void filter()
```
  - filter
```
protected String filter(String markupContent)
                 throws Exception
```
    Throws:
    
    Exception
  - parseForSpecialTags
```
protected void parseForSpecialTags(String markupContent)
```
  - getHeader
```
public String getHeader()
```
  - getContent
```
public String getContent()
```
  - getType
```
public WicketExtendInput.Include getType()
```
  - setType
```
public void setType(WicketExtendInput.Include type)
```
  - getSpecialTags
```
public Map<String,String> getSpecialTags()
```
    {@literal get the Special Tags like tag value. Only starting tag is parsed for.
  - getDefaultContentTransformer
```
public org.apache.commons.collections.Transformer getDefaultContentTransformer()
```
  - getContentTransformer
```
public org.apache.commons.collections.Transformer getContentTransformer()
```
    One can override contentTransformer with a Chain or another Transformer.
    To use the default Transformer in a chain you can refer to getDefaultContentTransformer(). This is useful if you wish do things like replace URL strings with CDN equivalent strings etc.
    
    Ensure the Transformer is also Serializable to avoid wicket from throwing warnings
  - setContentTransformer
```
public void setContentTransformer(org.apache.commons.collections.Transformer contentTransformer)
```
    One can override contentTransformer with a Chain or another Transformer.
    To use the default Transformer in a chain you can refer to getDefaultContentTransformer(). This is useful if you wish do things like replace URL strings with CDN equivalent strings etc.
    
    Ensure the Transformer is also Serializable to avoid wicket from throwing warnings

Class WicketExtendInput

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

Field Summary

Fields inherited from class org.apache.wicket.Component

Constructor Summary

Method Summary

Methods inherited from class com.neurosys.site.wicket.components.FilterInput

Methods inherited from class org.apache.wicket.markup.html.include.Include

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

Methods inherited from class org.apache.wicket.Component

Methods inherited from class java.lang.Object

Constructor Detail

WicketExtendInput

WicketExtendInput

WicketExtendInput

Method Detail

onComponentTagBody

filter

filter

parseForSpecialTags

getHeader

getContent

getType

setType

getSpecialTags

getDefaultContentTransformer

getContentTransformer

setContentTransformer