public class

FolderQuickSearchTransform

extends AbstractAppTransform
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.FolderQuickSearchTransform

Class Overview

Title: FolderQuickSearchTransform.

Summary

Constants
String FP_OBJECT_TYPES
String FP_ROOT_FOLDER_ID
String FP_SYS_FOLDER
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter objectTypes
public FormalParameter rootFolderId
public FormalParameter sysFolder
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderQuickSearchTransform()
Default constructor.
Public Methods
String getDescription()
Returns the textual description of the transform
Class getSupportedBeanType()
Returns the supported bean type.
void initializeTransform(Transformable data)

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

void renderPostContent(MarkupOutput out)
void renderPreContent(MarkupOutput out)
void renderQuickSearch(MarkupOutput out)
void renderSearchTextBox(MarkupOutput out)
void transformForRequestInError(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestEndsInError.
void transformForRequestSuccessful(MarkupOutput out)
Generates the graphical output for a ToolbarBean
Protected Methods
WebEvent getNewSearchEvent()
String getObjectTypes()
String getPreferenceSharedReportsFolderID()
Returns the value of the admin preference for shared reports, or null if it has not been set.
String getRootFolderId()
WebEvent getSearchEvent()
int getSysFolder()
[Expand]
Inherited Methods
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

Constants

public static final String FP_OBJECT_TYPES

Constant Value: "objectTypes"

public static final String FP_ROOT_FOLDER_ID

Constant Value: "rootFolderId"

public static final String FP_SYS_FOLDER

Constant Value: "sysFolder"

Fields

public FormalParameter objectTypes

public FormalParameter rootFolderId

public FormalParameter sysFolder

Public Constructors

public FolderQuickSearchTransform ()

Default constructor. Initializes formal parameters.

Public Methods

public String getDescription ()

Returns the textual description of the transform

Returns
  • the description of the transform

public Class getSupportedBeanType ()

Returns the supported bean type. This transform supports FolderBean instances

Returns
  • the class of the bean supported by this transform.

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 void renderPostContent (MarkupOutput out)

public void renderPreContent (MarkupOutput out)

public void renderQuickSearch (MarkupOutput out)

public void renderSearchTextBox (MarkupOutput out)

public void transformForRequestInError (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestEndsInError. This method just calls displayError(MarkupOutput, String, String, Exception) with the title and message based on the error code from the bean's ErrorInfo, as provided by the the getErrorTitle and getErrorMessage methods accordingly.
Transforms that would like to generate customized output based on the error should extend this method.

Parameters
out output by this transform

public void transformForRequestSuccessful (MarkupOutput out)

Generates the graphical output for a ToolbarBean

Parameters
out MarkupOutput instance where to create the HTML output

Protected Methods

protected WebEvent getNewSearchEvent ()

protected String getObjectTypes ()

protected String getPreferenceSharedReportsFolderID ()

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

protected String getRootFolderId ()

protected WebEvent getSearchEvent ()

protected int getSysFolder ()