# Uses of Interface
org.apache.tapestry5.MarkupWriter

Packages that use MarkupWriter
Package
Description
org.apache.tapestry5
Root package for Tapestry, containing common interfaces and data types used throughout the framework.
org.apache.tapestry5.beanvalidator
Support for JSR-303 Bean Validation via the Hibernate validator implementation
org.apache.tapestry5.corelib.base
Base components intended to be extended by other components rather than used directly in templates.
org.apache.tapestry5.corelib.components
The set of core components available in all Tapestry applications
org.apache.tapestry5.corelib.internal
[INTERNAL USE ONLY] support classes for the Tapestry-core module; API subject to change core components.
org.apache.tapestry5.corelib.pages
The set of core pages available in all Tapestry applications
org.apache.tapestry5.internal.beanvalidator
[INTERNAL USE ONLY] JSR-303 Bean Validation implementation details; API subject to change
org.apache.tapestry5.internal.dynamic
[INTERNAL USE ONLY] support classes for the `Dynamic` component; API subject to change
org.apache.tapestry5.internal.parser
[INTERNAL USE ONLY] support classes for component template rendering; API subject to change
org.apache.tapestry5.internal.renderers
[INTERNAL USE ONLY] support classes for component template rendering; API subject to change
org.apache.tapestry5.internal.services
[INTERNAL USE ONLY] internal service classes; API subject to change
org.apache.tapestry5.internal.services.ajax
[INTERNAL USE ONLY] AJAX support services; API subject to change
org.apache.tapestry5.internal.services.javascript
[INTERNAL USE ONLY] JavaScript support implementations; API subject to change
org.apache.tapestry5.internal.structure
[INTERNAL USE ONLY] page structure implementation details; API subject to change.
org.apache.tapestry5.internal.test
[INTERNAL USE ONLY] testing support implementation classes; API subject to change
org.apache.tapestry5.internal.translator
[INTERNAL USE ONLY] translator implementation classes; API subject to change.
org.apache.tapestry5.internal.util
[INTERNAL USE ONLY] various utility classes; API subject to change.
org.apache.tapestry5.runtime
Contains interfaces that are added to component classes at runtime.
org.apache.tapestry5.services
Core services
org.apache.tapestry5.test
Support for testing Tapestry pages
org.apache.tapestry5.upload.components
Tapestry-upload module components
org.apache.tapestry5.validator
Validators for use by Tapestry (and custom) form field components.

- ## Uses of MarkupWriter in org.apache.tapestry5

  Methods in org.apache.tapestry5 with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  FieldTranslator.`render(MarkupWriter writer)`
  Invokes `Translator.render(Field, String, MarkupWriter,org.apache.tapestry5.services.FormSupport)`.
  `void`
  FieldValidator.`render(MarkupWriter writer)`
  Invokes `Validator.render(Field, Object, org.apache.tapestry5.ioc.MessageFormatter, MarkupWriter, org.apache.tapestry5.services.FormSupport)`.
  `void`
  Renderable.`render(MarkupWriter writer)`
  `void`
  Translator.`render(Field field, String message, MarkupWriter writer, FormSupport formSupport)`
  Hook used by components to allow the validator to contribute additional attributes or (more often) client-side JavaScript (via the `FormSupport.addValidation(Field, String, String, Object)`).
  `void`
  Validator.`render(Field field, C constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  Hook used by components to allow the validator to contribute additional attributes or (more often) client-side JavaScript (via the `FormSupport.addValidation(Field, String, String, Object)`).
  `void`
  ComponentResources.`renderInformalParameters(MarkupWriter writer)`
  Indentifies all parameters that are not formal parameters and writes each as a attribute/value pair into the current element of the markup writer.

- ## Uses of MarkupWriter in org.apache.tapestry5.beanvalidator

  Methods in org.apache.tapestry5.beanvalidator with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  ClientConstraintDescriptor.`applyClientValidation(MarkupWriter writer, String message, Map<String,Object> attributes)`
  Applies the validation

- ## Uses of MarkupWriter in org.apache.tapestry5.corelib.base

  Methods in org.apache.tapestry5.corelib.base with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `protected Object`
  AbstractPropertyOutput.`renderPropertyValue(MarkupWriter writer, String overrideBlockId)`
  Invoked from subclasses to do the rendering.
  `protected abstract void`
  AbstractTextField.`writeFieldTag(MarkupWriter writer, String value)`
  Invoked from `AbstractTextField.begin(MarkupWriter)` to write out the element and attributes (typically, <input>).
  `protected final void`
  AbstractLink.`writeLink(MarkupWriter writer, Link link, Object... namesAndValues)`
  Writes an <a> element with the provided link as the href attribute.

- ## Uses of MarkupWriter in org.apache.tapestry5.corelib.components

  Methods in org.apache.tapestry5.corelib.components with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `protected final void`
  PasswordField.`writeFieldTag(MarkupWriter writer, String value)`
  `protected final void`
  TextArea.`writeFieldTag(MarkupWriter writer, String value)`
  `protected void`
  TextField.`writeFieldTag(MarkupWriter writer, String value)`

- ## Uses of MarkupWriter in org.apache.tapestry5.corelib.internal

  Constructors in org.apache.tapestry5.corelib.internal with parameters of type MarkupWriter
  Modifier
  Constructor
  Description
  ``
  `HiddenFieldPositioner(MarkupWriter writer, HiddenFieldLocationRules rules)`

- ## Uses of MarkupWriter in org.apache.tapestry5.corelib.pages

  Methods in org.apache.tapestry5.corelib.pages with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  PageCatalog.`onComponentTree(MarkupWriter writer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.beanvalidator

  Methods in org.apache.tapestry5.internal.beanvalidator with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  BeanFieldValidator.`render(MarkupWriter writer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.dynamic

  Methods in org.apache.tapestry5.internal.dynamic with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  DynamicTemplateElement.`render(MarkupWriter writer, RenderQueue queue, DynamicDelegate delegate)`
  The element should perform whatever rendering it wants.

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.parser

  Methods in org.apache.tapestry5.internal.parser with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  AttributeToken.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  CDATAToken.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  CommentToken.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  DefineNamespacePrefixToken.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  DTDToken.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  StartElementToken.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  TextToken.`render(MarkupWriter writer, RenderQueue queue)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.renderers

  Methods in org.apache.tapestry5.internal.renderers with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  AvailableValuesRenderer.`render(AvailableValues values, MarkupWriter writer)`
  `void`
  ComponentResourcesRenderer.`render(ComponentResources object, MarkupWriter writer)`
  `void`
  EventContextRenderer.`render(EventContext object, MarkupWriter writer)`
  `void`
  ListRenderer.`render(List list, MarkupWriter writer)`
  `void`
  LocationRenderer.`render(Location location, MarkupWriter writer)`
  `void`
  ObjectArrayRenderer.`render(Object[] array, MarkupWriter writer)`
  `void`
  RequestRenderer.`render(Request request, MarkupWriter writer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.services

  Classes in org.apache.tapestry5.internal.services that implement MarkupWriter
  Modifier and Type
  Class
  Description
  `class`
  `MarkupWriterImpl`
  Methods in org.apache.tapestry5.internal.services that return MarkupWriter
  Modifier and Type
  Method
  Description
  `MarkupWriter`
  MarkupWriterFactoryImpl.`newMarkupWriter(String pageName)`
  `MarkupWriter`
  MarkupWriterFactoryImpl.`newMarkupWriter(ContentType contentType)`
  `MarkupWriter`
  MarkupWriterFactoryImpl.`newMarkupWriter(Page page)`
  `MarkupWriter`
  MarkupWriterFactoryImpl.`newPartialMarkupWriter(String pageName)`
  `MarkupWriter`
  MarkupWriterFactoryImpl.`newPartialMarkupWriter(ContentType contentType)`
  `MarkupWriter`
  MarkupWriterFactoryImpl.`newPartialMarkupWriter(Page page)`
  Methods in org.apache.tapestry5.internal.services with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `ValidationDecorator`
  ValidationDecoratorFactoryImpl.`newInstance(MarkupWriter writer)`
  `void`
  CompositeFieldValidator.`render(MarkupWriter writer)`
  `void`
  FieldTranslatorImpl.`render(MarkupWriter writer)`
  `void`
  FieldValidatorImpl.`render(MarkupWriter writer)`
  `void`
  PageRenderQueue.`render(MarkupWriter writer)`
  Render to the markup writer, as setup by the `PageRenderQueue.initializeForCompletePage(org.apache.tapestry5.internal.structure.Page)` or `PageRenderQueue.addPartialRenderer(org.apache.tapestry5.runtime.RenderCommand)` methods.
  `void`
  PageRenderQueueImpl.`render(MarkupWriter writer)`
  `void`
  MarkupRendererTerminator.`renderMarkup(MarkupWriter writer)`
  `void`
  PageNameMetaInjector.`renderMarkup(MarkupWriter writer, MarkupRenderer delegate)`
  `void`
  PartialMarkupRendererTerminator.`renderMarkup(MarkupWriter writer, JSONObject reply)`
  `void`
  RenderCommandComponentEventResultProcessor.`renderMarkup(MarkupWriter writer, JSONObject reply, PartialMarkupRenderer renderer)`
  As a filter, this class does three things: It creates an outer element to capture the partial page content that will be rendered It does setup and cleanup with the `AjaxFormUpdateController` It extracts the child markup and stuffs it into the reply's "content" property.
  `void`
  PageMarkupRenderer.`renderPageMarkup(Page page, MarkupWriter writer)`
  Initializes the rendering using the `MarkupRenderer` pipeline.
  `void`
  PageMarkupRendererImpl.`renderPageMarkup(Page page, MarkupWriter writer)`
  `void`
  PageRenderQueue.`renderPartial(MarkupWriter writer, JSONObject reply)`
  Performs a partial markup render, as configured via `PageRenderQueue.addPartialRenderer(org.apache.tapestry5.runtime.RenderCommand)`.
  `void`
  PageRenderQueueImpl.`renderPartial(MarkupWriter writer, JSONObject reply)`
  `void`
  RenderQueueImpl.`run(MarkupWriter writer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.services.ajax

  Methods in org.apache.tapestry5.internal.services.ajax with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  SingleZonePartialRendererFilter.`renderMarkup(MarkupWriter writer, JSONObject reply, PartialMarkupRenderer renderer)`
  `void`
  AjaxFormUpdateController.`setupBeforePartialZoneRender(MarkupWriter writer)`
  Called before starting to render a zone's content; initializes the `FormSupport` and `ValidationTracker` environmentals and starts a heartbeat.
  `void`
  AjaxFormUpdateControllerImpl.`setupBeforePartialZoneRender(MarkupWriter writer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.services.javascript

  Methods in org.apache.tapestry5.internal.services.javascript with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  AddBrowserCompatibilityStyles.`renderMarkup(MarkupWriter writer, MarkupRenderer renderer)`
  `void`
  ConfigureHTMLElementFilter.`renderMarkup(MarkupWriter writer, MarkupRenderer renderer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.structure

  Methods in org.apache.tapestry5.internal.structure with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  BlockImpl.`render(MarkupWriter writer, RenderQueue queue)`
  Pushes all the elements of the body of this block onto the queue in appropriate order.
  `final void`
  ComponentPageElementImpl.`render(MarkupWriter writer, RenderQueue queue)`
  Pushes the SetupRender phase state onto the queue.
  `void`
  ExpansionPageElement.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  InternalComponentResourcesImpl.`render(MarkupWriter writer, RenderQueue queue)`
  `void`
  InternalComponentResourcesImpl.`renderInformalParameters(MarkupWriter writer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.test

  Methods in org.apache.tapestry5.internal.test with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  CaptureRenderedDocument.`renderMarkup(MarkupWriter writer, MarkupRenderer renderer)`

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.translator

  Methods in org.apache.tapestry5.internal.translator with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  NumericTranslator.`render(Field field, String message, MarkupWriter writer, FormSupport formSupport)`
  `void`
  StringTranslator.`render(Field field, String message, MarkupWriter writer, FormSupport formSupport)`
  Does nothing.

- ## Uses of MarkupWriter in org.apache.tapestry5.internal.util

  Methods in org.apache.tapestry5.internal.util with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  RenderableAsBlock.`render(MarkupWriter writer, RenderQueue queue)`
  Invokes `Renderable.render(org.apache.tapestry5.MarkupWriter)`.
  `void`
  StringRenderable.`render(MarkupWriter writer)`
  Constructors in org.apache.tapestry5.internal.util with parameters of type MarkupWriter
  Modifier
  Constructor
  Description
  ``
  `SelectModelRenderer(MarkupWriter writer, ValueEncoder encoder, boolean raw)`

- ## Uses of MarkupWriter in org.apache.tapestry5.runtime

  Methods in org.apache.tapestry5.runtime with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  Component.`afterRender(MarkupWriter writer, Event event)`
  Generally used to write the close tag matching any open tag written by `Component.beginRender(org.apache.tapestry5.MarkupWriter, Event)`.
  `void`
  Component.`afterRenderBody(MarkupWriter writer, Event event)`
  Invoked just after rendering the body of the component.
  `void`
  Component.`afterRenderTemplate(MarkupWriter writer, Event event)`
  Invoked after rendering the template for a component (only for components with a template).
  `void`
  Component.`beforeRenderBody(MarkupWriter writer, Event event)`
  Invoked just before rendering the body of component.
  `void`
  Component.`beforeRenderTemplate(MarkupWriter writer, Event event)`
  This phase is only invoked for components with templates.
  `void`
  Component.`beginRender(MarkupWriter writer, Event event)`
  Invoked to allow a component to render its tag (start tag and attributes).
  `void`
  Component.`cleanupRender(MarkupWriter writer, Event event)`
  Generally used to perform final cleanup of the component after rendering.
  `void`
  RenderCommand.`render(MarkupWriter writer, RenderQueue queue)`
  Invoked on an object to request that it render itself.
  `void`
  Component.`setupRender(MarkupWriter writer, Event event)`
  Invoked before rendering a component (or its template).

- ## Uses of MarkupWriter in org.apache.tapestry5.services

  Methods in org.apache.tapestry5.services that return MarkupWriter
  Modifier and Type
  Method
  Description
  `MarkupWriter`
  MarkupWriterFactory.`newMarkupWriter(String pageName)`
  Obtains a markup writer that will render the content for the provided logical page name.
  `MarkupWriter`
  MarkupWriterFactory.`newMarkupWriter(ContentType contentType)`
  Deprecated.
  use `MarkupWriterFactory.newMarkupWriter(Page)` instead which doesn't rely on the content type alone.
  `MarkupWriter`
  MarkupWriterFactory.`newMarkupWriter(Page page)`
  Obtains a markup writer that will render the content for the provided page.
  `MarkupWriter`
  MarkupWriterFactory.`newPartialMarkupWriter(String pageName)`
  Obtains a markup writer that will render the content for the provided logical page name, configured for partial page rendering (i.e., for a response to an Ajax request).
  `MarkupWriter`
  MarkupWriterFactory.`newPartialMarkupWriter(ContentType contentType)`
  Deprecated.
  use `MarkupWriterFactory.newPartialMarkupWriter(Page)` instead which doesn't rely on the content type alone.
  `MarkupWriter`
  MarkupWriterFactory.`newPartialMarkupWriter(Page page)`
  Obtains a markup writer that will render the content for the provided page, configured for partial page rendering (i.e., for a response to an Ajax request).
  Methods in org.apache.tapestry5.services with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `ValidationDecorator`
  ValidationDecoratorFactory.`newInstance(MarkupWriter writer)`
  Deprecated.
  Creates a new decorator for the indicated writer.
  `void`
  DefaultObjectRenderer.`render(Object object, MarkupWriter writer)`
  `void`
  ObjectRenderer.`render(T object, MarkupWriter writer)`
  Renders the object out as markup.
  `void`
  MarkupRenderer.`renderMarkup(MarkupWriter writer)`
  Invoked to render some markup.
  `void`
  MarkupRendererFilter.`renderMarkup(MarkupWriter writer, MarkupRenderer renderer)`
  Implementations should perform work before or after passing the writer to the renderer.
  `void`
  PartialMarkupRenderer.`renderMarkup(MarkupWriter writer, JSONObject reply)`
  Implementations should perform work before or after passing the writer to the renderer.
  `void`
  PartialMarkupRendererFilter.`renderMarkup(MarkupWriter writer, JSONObject reply, PartialMarkupRenderer renderer)`
  Implementations should perform work before or after passing the writer to the renderer.

- ## Uses of MarkupWriter in org.apache.tapestry5.test

  Methods in org.apache.tapestry5.test that return MarkupWriter
  Modifier and Type
  Method
  Description
  `protected final MarkupWriter`
  TapestryTestCase.`createMarkupWriter()`
  Creates a new markup writer instance (not a markup writer mock).
  `protected final MarkupWriter`
  TapestryTestCase.`mockMarkupWriter()`
  Methods in org.apache.tapestry5.test with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `protected final void`
  TapestryTestCase.`train_renderInformalParameters(ComponentResources resources, MarkupWriter writer, Object... informals)`

- ## Uses of MarkupWriter in org.apache.tapestry5.upload.components

  Methods in org.apache.tapestry5.upload.components with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  Upload.`afterRender(MarkupWriter writer)`
  `protected void`
  Upload.`beginRender(MarkupWriter writer)`
  Render the upload tags.

- ## Uses of MarkupWriter in org.apache.tapestry5.validator

  Methods in org.apache.tapestry5.validator with parameters of type MarkupWriter
  Modifier and Type
  Method
  Description
  `void`
  Checked.`render(Field field, Void constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  `void`
  Email.`render(Field field, Void constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  `void`
  Max.`render(Field field, Long constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  `void`
  MaxLength.`render(Field field, Integer constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  `void`
  Min.`render(Field field, Long constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  `void`
  MinLength.`render(Field field, Integer constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  `void`
  None.`render(Field field, Void constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  Does nothing.
  `void`
  Regexp.`render(Field field, Pattern constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`
  `void`
  Required.`render(Field field, Void constraintValue, MessageFormatter formatter, MarkupWriter writer, FormSupport formSupport)`