public class

FolderQuickSearchResultsXHTMLTransform

extends FolderSearchResultsXHTMLTransform
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
               ↳ com.microstrategy.web.app.transforms.FolderSearchResultsXHTMLTransform
                 ↳ com.microstrategy.web.app.transforms.FolderQuickSearchResultsXHTMLTransform
Known Direct Subclasses

Class Overview

This class extends the FolderSearchResultsXHTMLTransform by rendering specific messages related to Quick Search results.
The output of this Transform generates JSON object { ts: total number of match items, bb: block begin of this search rquest html: the results html string generated by {FolderSearchResultsXHTMLTransform} }

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderQuickSearchResultsXHTMLTransform()
Public Methods
boolean canCopy(WebObjectInfo object)
Checks if all privileges and access control are enabled to make a copy of the object.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

void renderEmptyList(MarkupOutput out)
Renders the folder when it has no children.
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

Protected Methods
boolean getDereferenceShortcuts(WebObjectInfo object)
Get 'dereferenceShortcuts' flag
Tag getNameWrapperTag(WebObjectInfo object)
Override to highlight name pattern
void setBoneProperties(JsonGenerator boneProps)
Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderSearchResultsXHTMLTransform
From class com.microstrategy.web.app.transforms.FolderViewTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Public Constructors

public FolderQuickSearchResultsXHTMLTransform ()

Public Methods

public boolean canCopy (WebObjectInfo object)

Checks if all privileges and access control are enabled to make a copy of the object.

Parameters
object the corresponding WebObjectInfo

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform It also invokes the initializeWebComponent, initializeImages and initializeCss methods.

This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.

Parameters
data the bean to transform.

public void renderEmptyList (MarkupOutput out)

Renders the folder when it has no children. The HTML to render for this case includes only a SPAN HTML tag, with the empty-list corresponding style, displaying the localized descriptor for This folder is empty.

Parameters
out MarkupOutput instance where the transform's output will be saved.

public void renderShell (MarkupOutput out)

Generates the shell for this Transform.

The shell is a <div> tag that automatically surrounds the content generated by the Transform. It's used among other things by the javascript to identify the HTML associated with a bone, and by the iFrame update technology to identify a component in the page.

The attributes to append to this <div> are obtained from the getAttributesShellDiv method; the style from the getStyleShellDiv method.
This method calls renderCssLink and checkStatus to generate the Transform's content.

Parameters
out output by this transform

Protected Methods

protected boolean getDereferenceShortcuts (WebObjectInfo object)

Get 'dereferenceShortcuts' flag

Returns
  • Default 'true' - //retun true to be consistent with existing behavior

protected Tag getNameWrapperTag (WebObjectInfo object)

Override to highlight name pattern

Parameters
object WebObjectInfo instance to be rendered.
Returns
  • a Tag instance with the name of the object to render already embedded. Might return null, in which case the object name will have to be obtained by calling the getObjectName(WebObjectInfo) method separately.

protected void setBoneProperties (JsonGenerator boneProps)

Sets the necessary properties to the bone assigned to this transform (based on the scriptClass formal parameter)
Usually called by renderRegisterBone(MarkupOutput)
Can be overwritten to add or modify bone properties.

Parameters
boneProps the JsonGenerator object that contains the collection of bone properties.