public class

SearchSuggestTransform

extends SearchSimpleTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.SearchSimpleTransform
           ↳ com.microstrategy.web.app.transforms.SearchSuggestTransform

Class Overview

Transform for the search page

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.SearchSimpleTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected PageComponent _mstrPage Property to keep the information about the PageComponent associated with the page currently being rendered
protected FormalParameter defaultRootFolderType Search scope folder that used when no explicit folder is given (default as "All Folders").
protected FormalParameter id Indicates the name of the outer shell for all folder modes.
protected FormalParameter isMiniSearchBox Flag to indicate whether this is SearchBox in ShortcutsBar.
protected FormalParameter isServerSearch Flag to indicate whether this is SearchBox in IServer Admin page (Users and Security Roles Search)
protected FormalParameter showAsPopup Flag to indicate whether to show Search Results in a Popup This should be true for QuickSearchBox in ShortcutsBar, and SearchBox in Desktop Page.
protected FormalParameter showSettings Flag to indicate where to make Advanced Search Options visible.
protected FormalParameter showSuggestionAsPopup Flag to indicate whether to show Suggestion List in a popup; or just below the SearchBox This should be true for QuickSearchBox in ShortcutsBar, and SearchBox in Desktop Page.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.SearchSimpleTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SearchSuggestTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
Map addAttr(String name, String value)
Map addAttr(String name, int descId)
Map addTitleAttr(int descId)
String getID()
Returns the unique name of the component to be used as the ID for its shell.
void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

boolean isSettingVisible()
void renderJavaScriptFooter(MarkupOutput out)
Renders javascript variables at the bottom of the transform to be used in DHTML mode.
void renderShell(MarkupOutput out)

Generates the shell for this Transform.

void setObjectTypes(String value)
Sets the list of object-types used for searching.
void setRootFolderId(String value)
Sets the id of the folder to be used as root for searching.
void setSysFolder(String sysFolder)
Sets the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching.
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
Block createSearchBlock(MarkupOutput out)
String getObjectTypes()
Returns a comma separated list of object-types.
String getPreferenceSharedReportsFolderID()
Returns the value of the admin preference for shared reports, or null if it has not been set.
String getRootFolderId()
Returns the id of the folder to be used as root for searching.
int getSysFolder()
Returns the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching.
void setBoneProperties(JsonGenerator boneProps)
If we render bone shell from transform, then we want to pass these properties to the bone.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.SearchSimpleTransform
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

Fields

protected PageComponent _mstrPage

Property to keep the information about the PageComponent associated with the page currently being rendered

protected FormalParameter defaultRootFolderType

Search scope folder that used when no explicit folder is given (default as "All Folders"). Such as in Home, Search, Preferences page. But not in pages that have explicit folder, such as My Reports, Shared Reports, or navigating to any folder. Value options: Root Folder, My Reports, Shared Reports that defined in @EnumDSSXMLFolderNames;

protected FormalParameter id

Indicates the name of the outer shell for all folder modes.

protected FormalParameter isMiniSearchBox

Flag to indicate whether this is SearchBox in ShortcutsBar.

protected FormalParameter isServerSearch

Flag to indicate whether this is SearchBox in IServer Admin page (Users and Security Roles Search)

protected FormalParameter showAsPopup

Flag to indicate whether to show Search Results in a Popup This should be true for QuickSearchBox in ShortcutsBar, and SearchBox in Desktop Page.

protected FormalParameter showSettings

Flag to indicate where to make Advanced Search Options visible. This should be true for Desktop Page and Search Page SearchBox.

protected FormalParameter showSuggestionAsPopup

Flag to indicate whether to show Suggestion List in a popup; or just below the SearchBox This should be true for QuickSearchBox in ShortcutsBar, and SearchBox in Desktop Page.

Public Constructors

public SearchSuggestTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public Map addAttr (String name, String value)

public Map addAttr (String name, int descId)

public Map addTitleAttr (int descId)

public String getID ()

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
  • the component's unique id

public void initializeTransform (Transformable data)

This method initialize the private and protected fields of the transform, such as width and height. 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 boolean isSettingVisible ()

public void renderJavaScriptFooter (MarkupOutput out)

Renders javascript variables at the bottom of the transform to be used in DHTML mode.

Parameters
out where to write the output of the method.

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

public void setObjectTypes (String value)

Sets the list of object-types used for searching. This must be a comma separated list of object-types. Valid object types are those from the EnumDSSXMLObjectSubTypes or EnumDSSXMLObjectTypes enumerations.

public void setRootFolderId (String value)

Sets the id of the folder to be used as root for searching. This must be a valid id of a folder existing in the md.

public void setSysFolder (String sysFolder)

Sets the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching. When a non-system folder should be used, this value must be set to "0". Assigning any other value will clear the root folder id parameter.

See Also

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful".

Parameters
out output by this transform

Protected Methods

protected Block createSearchBlock (MarkupOutput out)

Throws
Exception

protected String getObjectTypes ()

Returns a comma separated list of object-types. If this parameter is not explicitly set, this method will return the default list of object types, that is: reports, documents and folders.

protected String getPreferenceSharedReportsFolderID ()

Returns the value of the admin preference for shared reports, or null if it has not been set.

protected String getRootFolderId ()

Returns the id of the folder to be used as root for searching. If this parameter has not been explicitly set, it will be calculated based on the application context.

protected int getSysFolder ()

Returns the system folder name as defined in EnumDSSXMLFolderNames to be used as root for searching. When a folder-id is also set, this method will return "0". If shared-reports has been set, this method might return "0" if the admin has configured a custom folder for shared reports.
If this parameter has not been explicitly set, it will be calculated based on the application context.

protected void setBoneProperties (JsonGenerator boneProps)

If we render bone shell from transform, then we want to pass these properties to the bone.

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