java.lang.Object | ||||||
↳ | com.microstrategy.web.transform.AbstractTransform | |||||
↳ | com.microstrategy.web.transform.AbstractLayoutTransform | |||||
↳ | com.microstrategy.web.app.transforms.AbstractAppTransform | |||||
↳ | com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform | |||||
↳ | com.microstrategy.web.app.transforms.AbstractFolderTransform | |||||
↳ | com.microstrategy.web.app.transforms.FolderViewTransform |
![]() |
![]() |
This transform is used by MicroStrategy Web and Web Universal to display both the Icon View as well as the List View of folder contents. Each view's representation comes from a different layout XHTML file. See the MSDL to learn more about how Layout Transforms and Layout XML work and can be used in the Style Catalog. When no layout file is supplied to this transform, it renders the look and feel of Icon View by default.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
class | FolderViewTransform.ClientEvent |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | CM_FLAG_ALL |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
int | CM_FLAG_COPY |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
int | CM_FLAG_CREATE_SHORTCUT |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
int | CM_FLAG_DELETE |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
int | CM_FLAG_MOVE |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
int | CM_FLAG_PROPERTIES |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
int | CM_FLAG_RENAME |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
String | FP_CONTEXT_MENU_FLAGS |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
protected WebDisplayUnits | _itemsList |
This field is deprecated.
please use the results from getSortedList() or getSortedChildUnits()
instead. This property is no longer used in the code. |
|||||||||
public FormalParameter | contextMenuFlags |
This field is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
|
|||||||||
protected FormalParameter | id | Indicates the name of the outer shell for all folder modes. | |||||||||
protected FormalParameter | renderLinks | Indicates that if the user want's to render folder browsing links, by default it is set to true. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
FolderViewTransform()
Default no-argument constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Map |
addSummaryAttribute()
Return the Summary Attribute to be used in the table for the transform.
| ||||||||||
boolean |
canCopy(WebObjectInfo object)
Checks if all privileges and access control are enabled to make a copy of the object.
| ||||||||||
boolean |
canCreateShortcut(WebObjectInfo object)
Checks if all privileges and access control are enabled to create a Shortcut
to the given object.
| ||||||||||
boolean |
canDisplayProperties(WebObjectInfo object)
Checks if all privileges and access control are enabled to display the properties of the given object.
| ||||||||||
boolean |
canMove(WebObjectInfo object)
Checks if all privileges and access control are enabled to change the location of the object.
| ||||||||||
boolean |
canRename(WebObjectInfo object)
Checks if all privileges and access control are enabled to rename the given object.
| ||||||||||
boolean |
checkContextMenuFlag(int flag)
Check if the level parameter value contains this flag.
| ||||||||||
WebEvent |
getCopyEvent(WebObjectInfo object)
Returns an event to make a copy of the object.
| ||||||||||
WebEvent | getCreateAnalysisFromReportEvent(WebObjectInfo object) | ||||||||||
WebEvent | getCreateDocumentFromDossierEvent(WebObjectInfo object) | ||||||||||
WebEvent | getCreateDocumentFromReportEvent(WebObjectInfo object) | ||||||||||
WebEvent | getCreateDocumentFromThemeEvent(WebObjectInfo object) | ||||||||||
WebEvent | getCreateHTML5VIFromReportEvent(WebObjectInfo object, boolean isJsonMode) | ||||||||||
WebEvent | getCreateReportFromCubeEvent(WebObjectInfo object) | ||||||||||
WebEvent |
getCreateShortcutEvent(WebObjectInfo object)
Returns an event to create a Shortcut
to the given object.
| ||||||||||
String |
getDescription()
Return the description for this Transform
| ||||||||||
WebEvent |
getDisplayPropertiesEvent(WebObjectInfo object)
Returns an event to show the properties of the given object.
| ||||||||||
WebEvent |
getEditEvent(WebObjectInfo object)
Returns an initialized
WebEvent to edit an object. | ||||||||||
WebEvent | getEvent(WebObjectInfo object, boolean cubeRepublish) | ||||||||||
WebEvent |
getEvent(WebObjectInfo object)
Based on the object type on the
WebObjectInfo sent as parameter, it
creates and initializes the corresponding WebEvent for having the object
opened or run. | ||||||||||
WebEvent |
getExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, corresponding to the
user preference on where the export result should be displayed
| ||||||||||
WebEvent |
getFlashExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, corresponding to the
user preference on where the export result should be displayed
| ||||||||||
String | getFolderName(WebFolder folder) | ||||||||||
ArrayList |
getFolderObjects()
This method is deprecated.
please use
getSortedList() instead
| ||||||||||
WebEvent | getHtmlExportEvent(WebObjectInfo object) | ||||||||||
String |
getID()
Returns the unique name of the component to be used as the ID for its shell.
| ||||||||||
WebEvent |
getMoveEvent(WebObjectInfo object)
Returns an event to change the location of the object.
| ||||||||||
WebEvent | getNewFilterEvent() | ||||||||||
WebEvent | getNewPromptEvent(String promptType, String promptExpressionType) | ||||||||||
String | getObjectID(WebObjectInfo object) | ||||||||||
String | getObjectModificationTimeStamp(WebObjectInfo object) | ||||||||||
WebEvent |
getPDFExportEvent(WebObjectInfo object)
Overwrites the parent method by assigning a target to the event, corresponding to the
user preference on where the export result should be displayed
| ||||||||||
WebEvent |
getRenameEvent(WebObjectInfo object)
Returns an event to rename the given object.
| ||||||||||
JsonGenerator | getRepublishCubeConfigJSON(WebObjectInfo object, String type) | ||||||||||
String | getTimestamp(WebObjectInfo object) | ||||||||||
boolean | hasMultipleRunModesAvailable(WebObjectInfo object) | ||||||||||
boolean |
isActionsTabAvailable()
Convenience method to check whether we need to render the Actions Tab based on the features available.
| ||||||||||
boolean |
isFolderNotNull(WebObjectInfo object)
Convenience method to check object is Null.
| ||||||||||
void | renderAnchorTag(MarkupOutput out, WebObjectInfo object) | ||||||||||
void |
renderContextMenu(WebObjectInfo object, Tag span)
This method is deprecated.
Use
getContextMenuAttributes(WebObjectInfo)
| ||||||||||
void |
renderDeleteInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
Write out delete information for a single object, as a link based on
the event generated by the
getDeleteEvent() method and the user privileges. | ||||||||||
void |
renderDescriptionInfo(MarkupOutput out, WebObjectInfo object, boolean renderBlankspace)
Write out description information for a single object.
| ||||||||||
void |
renderEditInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
Write out edit information for a single object, as a link based on
the event generated by the
getEditEvent() method and the user privileges. | ||||||||||
void |
renderExport(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
Write out information for exporting a single object, as a link based on
the event generated by the
getExportEvent() method and the user privileges. | ||||||||||
void |
renderFolderDescription(MarkupOutput out)
Renders the description of the current folder.
| ||||||||||
void |
renderFolderName(MarkupOutput out)
Renders the name of the current folder.
| ||||||||||
void |
renderIconInfo(MarkupOutput out, WebObjectInfo object, boolean includeStyleAttribute)
Write out the image information for a single object.
| ||||||||||
void |
renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object, boolean includeStyleAttribute)
Similar to
renderIconInfo(MarkupOutput, WebObjectInfo) , but instead
of generating an IMG tag, having a transparent image as its source and a background
image assigned via the CSS style, it will now generate a SPAN tag which will
have the same css class defined (where the background image is indicated) and an
inner SPAN for the layering effect, in case an additional image has to be included, on top
of the original (for example, a shortcut arrow, a red error sign, etc). | ||||||||||
void |
renderLayeredIconInfo(MarkupOutput out, WebObjectInfo object, boolean includeStyleAttribute, boolean largeIconView)
NOTE: overloaded to accept additional parameter 'iconView' for new style process
Similar to
renderIconInfo(MarkupOutput, WebObjectInfo) , but instead
of generating an IMG tag, having a transparent image as its source and a background
image assigned via the CSS style, it will now generate a SPAN tag which will
have the same css class defined (where the background image is indicated) and an
inner SPAN for the layering effect, in case an additional image has to be included, on top
of the original (for example, a shortcut arrow, a red error sign, etc). | ||||||||||
void |
renderList(MarkupOutput out, WebDisplayUnits list)
This method is deprecated.
please use and customize
renderList(MarkupOutput) instead since
this method will not be called by future releases.
| ||||||||||
void |
renderMenuArrow(MarkupOutput out)
Render a "down" arrow to open context menu when clicking
| ||||||||||
void |
renderModifiedInfo(MarkupOutput out, WebObjectInfo object)
Write out modified time information for a single object.
| ||||||||||
void |
renderOwnerInfo(MarkupOutput out, WebObjectInfo object)
Write out owner information for a single object
| ||||||||||
void |
renderPDFExport(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
Write out information for exporting to PDF a single object, as a link based on
the event generated by the
getPDFExportEvent() method and the user privileges. | ||||||||||
void |
renderSendNowInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
Write out narrocast send now information for a single object, as a link based on
the event generated by the
getSendNowEvent() method. | ||||||||||
void |
renderSubscriptionInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
Write out subscription information for a single object, as a link based on
the event generated by the
getSubscriptionsEvent() method and the user privileges. |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AnchorTag |
generateAnchor(WebEvent event, WebObjectInfo obj)
Generates anchor based on event.
| ||||||||||
AnchorTag |
generateAnchor(WebEvent event)
Generates anchor based on event.
| ||||||||||
String |
getActionImageSrc(String action)
Get the image source to display as part of the action button.
| ||||||||||
String | getDeleteTooltip(WebObjectInfo object) | ||||||||||
Tag | getNameWrapperTag(WebObjectInfo object) | ||||||||||
ObjectManipulationDialogBean | getObjectManipulationBean() | ||||||||||
WebEvent |
getOpenObjectManipulationDialogEvent(WebObjectInfo object, int action)
Returns an event to open the object manipulation dialog. | ||||||||||
void |
renderEmptyCellForActions(MarkupOutput out, boolean renderCellAsText)
Convenience method that renders the content for the action.
| ||||||||||
boolean | shouldDisplayDeleteInfo() |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Value for the contextMenuFlags
formal parameter.
Specifies that the all context menu entry shall be rendered by transform.
Value = 0xffffffff
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Flag value for the contextMenuFlags
formal parameter.
Specifies that the Copy context menu entry shall be rendered by transform.
Value = 1
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Flag value for the contextMenuFlags
formal parameter.
Specifies that the Create Shortcut context menu entry shall be rendered by transform.
Value = 4
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Flag value for the contextMenuFlags
formal parameter.
Specifies that the Delete context menu entry shall be rendered by transform.
Value = 8
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Flag value for the contextMenuFlags
formal parameter.
Specifies that the Move context menu entry shall be rendered by transform.
Value = 2
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Flag value for the contextMenuFlags
formal parameter.
Specifies that the Properties context menu entry shall be rendered by transform.
Value = 32
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Flag value for the contextMenuFlags
formal parameter.
Specifies that the Rename context menu entry shall be rendered by transform.
Value = 16
This constant is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Constant specifying the name of the formal parameter for controlling context menu. Value is contextMenuFlags.
This field is deprecated.
please use the results from getSortedList()
or getSortedChildUnits()
instead. This property is no longer used in the code.
Property that holds the list of items to be rendered by this transform
This field is deprecated.
To customize context-menus use the xml-definition specified by contextMenus
Indicates the options to display on each context menu for the different items on the folder.
The options may include copy, create shortcut, move, etc. Multiple options might be rendered
at the same time. For indicating which ones to show, the value to assign to this formal parameter should be a
bitwise flag combining constants such as CM_FLAG_COPY
, CM_FLAG_MOVE
, etc.
Usage: If copy and move options should be displayed, the value to assign to the
formal parameter would be 3 (1 + 2).
Default value is CM_FLAG_ALL
Indicates that if the user want's to render folder browsing links, by default it is set to true.
Default no-argument constructor. Initializes formal parameters.
Return the Summary Attribute to be used in the table for the transform.
java.util.Map
with the attribute name (as key) and the value.
Checks if all privileges and access control are enabled to make a copy of the object.
object | the corresponding WebObjectInfo
|
---|
Checks if all privileges and access control are enabled to create a Shortcut to the given object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to display the properties of the given object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to change the location of the object.
object | the corresponding WebObjectInfo |
---|
Checks if all privileges and access control are enabled to rename the given object.
object | the corresponding WebObjectInfo |
---|
Check if the level parameter value contains this flag. This method
calls checkLevel(FormalParameter, int)
using the contextMenuFlags
parameter
flag | value to test for |
---|
Returns an event to make a copy of the object.
object | the corresponding WebObjectInfo |
---|
Returns an event to create a Shortcut to the given object.
object | the corresponding WebObjectInfo |
---|
Return the description for this Transform
String
with the description for the transform.
Returns an event to show the properties of the given object.
object | the corresponding WebObjectInfo |
---|
Returns an initialized WebEvent
to edit an object.
object | the WebObjectInfo instance of the object to edit. |
---|
WebEvent
instance initialized if possible, null
if the application doesn't support it.
Based on the object type on the WebObjectInfo
sent as parameter, it
creates and initializes the corresponding WebEvent
for having the object
opened or run.
object | a WebObjectInfo for which the "execution" event must be retrieved. |
---|
DssXmlTypeReportDefinition
, the REPORT_EVENT_EXECUTE
event,
DssXmlTypeFolder
, the FOLDER_EVENT_BROWSE
event.
DssXmlTypeDocumentDefinition
, the DOCUMENT_EVENT_EXECUTE_DOCUMENT
event.
DssXmlTypeFilter
, the WebEventSelectFilter
event.
DssXmlTypeTemplate
, the WebEventSelectTemplate
event.null
.
Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayed
object | the WebObjectInfo instance which will be exported if the event is called. |
---|
WebEvent
object if the application supports it. Otherwise, will return null
.
Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayed
object | the WebObjectInfo instance which will be exported if the event is called. |
---|
WebEvent
object if the application supports it. Otherwise, will return null
.
This method is deprecated.
please use getSortedList()
instead
Retrieve the list of the objects in the folder.
java.util.ArrayList
with the contents
as WebObjectInfo
WebObjectInfo
Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).
Returns an event to change the location of the object.
object | the corresponding WebObjectInfo |
---|
Overwrites the parent method by assigning a target to the event, corresponding to the user preference on where the export result should be displayed
object | the WebObjectInfo instance which will be exported if the event is called. |
---|
WebEvent
object if the application supports it. Otherwise, will return null
.
Returns an event to rename the given object.
object | the corresponding WebObjectInfo |
---|
Convenience method to check whether we need to render the Actions Tab based on the features available.
Convenience method to check object is Null.
object | WebObjectInfo Object to be checked for null. |
---|
This method is deprecated.
Use getContextMenuAttributes(WebObjectInfo)
Render the Context Menu and attached to the tag being passed
object | WebObjectInfo |
---|---|
span | Tag |
Write out delete information for a single object, as a link based on
the event generated by the getDeleteEvent()
method and the user privileges.
with CSS class defined as del
.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
renderLinkAsText | boolean determine whether to render the URL as text.
(otherwise it is rendered as an image).
|
Write out description information for a single object.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
renderBlankspace | boolean to specify whether it should render a empty cell when
it is empty. (otherwise no content is rendered).
|
Write out edit information for a single object, as a link based on
the event generated by the getEditEvent()
method and the user privileges.
with CSS class defined as edi
.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
renderLinkAsText | boolean determine whether to render the URL as text.
(otherwise it is rendered as an image).
|
Write out information for exporting a single object, as a link based on
the event generated by the getExportEvent()
method and the user privileges.
with CSS class defined as exp
.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
renderLinkAsText | boolean determine whether to render the URL as text.
(otherwise it is rendered as an image).
|
Renders the description of the current folder.
out | MarkupOutput instance with the output by this transform
|
---|
Renders the name of the current folder.
out | MarkupOutput instance with the output by this transform
|
---|
Write out the image information for a single object. The css class of the image
(which defines the GIF to use) is determined by the object type.
The image will be rendered as a link if the event according to the object type,
provided by the getEvent()
method, is available.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
includeStyleAttribute | boolean value indicating if css style should be added to the icon information generated. |
Similar to renderIconInfo(MarkupOutput, WebObjectInfo)
, but instead
of generating an IMG tag, having a transparent image as its source and a background
image assigned via the CSS style, it will now generate a SPAN tag which will
have the same css class defined (where the background image is indicated) and an
inner SPAN for the layering effect, in case an additional image has to be included, on top
of the original (for example, a shortcut arrow, a red error sign, etc).
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
includeStyleAttribute | boolean value indicating if css style should be added to the icon information generated. |
NOTE: overloaded to accept additional parameter 'iconView' for new style process
Similar to renderIconInfo(MarkupOutput, WebObjectInfo)
, but instead
of generating an IMG tag, having a transparent image as its source and a background
image assigned via the CSS style, it will now generate a SPAN tag which will
have the same css class defined (where the background image is indicated) and an
inner SPAN for the layering effect, in case an additional image has to be included, on top
of the original (for example, a shortcut arrow, a red error sign, etc).
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
includeStyleAttribute | boolean value indicating if css style should be added to the icon information generated. |
largeIconView | flag indicating if it is generating a large icon view of folders |
This method is deprecated.
please use and customize renderList(MarkupOutput)
instead since
this method will not be called by future releases.
Renders the list of objects contained in the folder (getSortedList()
)
as an HTML TABLE. The
header and each one of the objects inside the folder will be displayed
as a row of the main table.
No Summary attribute will be added to the main
table unless the user has selected Accessibility Mode from Preferences, in which case
the localized string for This table displays the requested folder contents will
be used by default.
out | MarkupOutput instance with the output by this transform |
---|---|
list | WebDisplayUnits list with the objects to render |
Render a "down" arrow to open context menu when clicking
Write out modified time information for a single object.
out | MarkupOutput instance where the contents generated will be stored. |
---|---|
object | WebObjectInfo instance to be rendered.
|
Write out owner information for a single object
out | MarkupOutput instance where the contents generated will be stored. |
---|---|
object | WebObjectInfo instance to be rendered.
|
Write out information for exporting to PDF a single object, as a link based on
the event generated by the getPDFExportEvent()
method and the user privileges.
with CSS class defined as pdf
.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
renderLinkAsText | boolean determine whether to render the URL as text.
(otherwise it is rendered as an image).
|
Write out narrocast send now information for a single object, as a link based on
the event generated by the getSendNowEvent()
method.
with CSS class defined as snd
.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
renderLinkAsText | boolean determine whether to render the URL as text.
(otherwise it is rendered as an image).
|
Write out subscription information for a single object, as a link based on
the event generated by the getSubscriptionsEvent()
method and the user privileges.
with CSS class defined as sub
.
out | MarkupOutput instance where to save the contents to display |
---|---|
object | WebObjectInfo to be rendered. |
renderLinkAsText | boolean determine whether to render the URL as text.
(otherwise it is rendered as an image).
|
Generates anchor based on event. This method will check for ClientEvent, the type only known by this class
Generates anchor based on event. This method will check for ClientEvent, the type only known by this class
event | the WebEvent to generate the link with the request |
---|
AnchorTag
instance initialized with the information from the eventGet the image source to display as part of the action button. This method is called only when the user has turned on Accessibility mode under Preferences.
action | String indicating the ID of the action from where the source should be calculated. For example, values
like pdf , sub , del or exp are expected |
---|
object | WebObjectInfo instance to be rendered. |
---|
getObjectName(WebObjectInfo)
method separately.
Returns an event to open the object manipulation dialog. This event is the one
actually triggered by several of the actions inside a folder, like copy/move/properties/rename.
All these events internally call this passing the corresponding action. The actions are defined
in the ObjectManipulationDialogBean
itself.
object | WebObjectInfo the object info to manipulate |
---|---|
action | the action to trigger. Possible actions are defined in the ObjectManipulationDialogBean |
Convenience method that renders the content for the action. If the renderCellAsText is false it renders a transparent blank image.
out | MarkupOutput instance to write output to. |
---|---|
renderCellAsText | for the text based rendering. |