Copyright© 2008-2022 Sitevision AB, all rights reserved.
@Requireable(value="TextModuleRendererBuilder") public interface TextModuleRendererBuilder extends Builder<TextModuleRenderer>
Builder for creating a TextModuleRenderer
instance.
TextModuleRendererBuilder has one mandatory attribute:
Using the TextModuleRendererBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:
When you have built a TextModuleRenderer
instance, you can re-use the TextModuleRendererBuilder to build more instances.
Typically like:
Tip! The Builder interface documentation
contains
more information about Builders and how to work with them and TextModuleRenderer
has a code example of how
this builder and its result can be used.
An instance of the Sitevision class implementing this interface can be obtained via
Utils.getTextModuleRendererBuilder()
.
See Utils
for how to obtain an instance of the TextModuleRendererBuilder
interface.
Modifier and Type | Method and Description |
---|---|
TextModuleRenderer |
build()
Creates a TextModuleRenderer instance for the page of this builder.
|
TextModuleRendererBuilder |
setPage(Node aPageNode)
Sets the page of this builder.
|
TextModuleRendererBuilder setPage(Node aPageNode)
aPageNode
- a page (sv:page, sv:article, sv:sitePage)TextModuleRenderer build() throws IllegalStateException
build
in interface Builder<TextModuleRenderer>
IllegalStateException
- if no valid page is setSitevision - Portal and Content Management Made Easy
Sitevision is an advanced Java enterprise portal product and a portlet container (JSR 286) that implements Java Content Repository (JSR 283).
Copyright© 2008-2022 Sitevision AB, all rights reserved.