Package com.microstrategy.web.app.transforms

Class FolderQuickSearchTransform

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

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

public class FolderQuickSearchTransform
extends AbstractAppTransform
implements LayoutTransform

Title: FolderQuickSearchTransform.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

AbstractAppTransform.Context

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	FP_OBJECT_TYPES
static java.lang.String	FP_ROOT_FOLDER_ID
static java.lang.String	FP_SYS_FOLDER
FormalParameter	objectTypes
FormalParameter	rootFolderId
FormalParameter	sysFolder

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors

Constructor	Description
FolderQuickSearchTransform()	Default constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Returns the textual description of the transform
protected WebEvent	getNewSearchEvent()
protected java.lang.String	getObjectTypes()
protected java.lang.String	getPreferenceSharedReportsFolderID()	Returns the value of the admin preference for shared reports, or null if it has not been set.
protected java.lang.String	getRootFolderId()
protected WebEvent	getSearchEvent()
java.lang.Class	getSupportedBeanType()	Returns the supported bean type.
protected int	getSysFolder()
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 EnumRequestStatus.WebBeanRequestEndsInError.
void	transformForRequestSuccessful(MarkupOutput out)	Generates the graphical output for a ToolbarBean

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeImages, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform

canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform

Field Detail

FP_OBJECT_TYPES

public static final java.lang.String FP_OBJECT_TYPES

See Also:

Constant Field Values

FP_ROOT_FOLDER_ID

public static final java.lang.String FP_ROOT_FOLDER_ID

See Also:

Constant Field Values

FP_SYS_FOLDER

public static final java.lang.String FP_SYS_FOLDER

See Also:

Constant Field Values

objectTypes

public FormalParameter objectTypes

rootFolderId

public FormalParameter rootFolderId

sysFolder

public FormalParameter sysFolder

Constructor Detail

FolderQuickSearchTransform

public FolderQuickSearchTransform()

Default constructor. Initializes formal parameters.

Method Detail

initializeTransform

public void initializeTransform(Transformable data)

Description copied from class: AbstractAppTransform

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.

Specified by:

initializeTransform in interface AppTransform

Overrides:

initializeTransform in class AbstractAppTransform

Parameters:

data - the bean to transform.

getSupportedBeanType

public java.lang.Class getSupportedBeanType()

Returns the supported bean type. This transform supports FolderBean instances

Specified by:

getSupportedBeanType in interface Transform

Overrides:

getSupportedBeanType in class AbstractAppTransform

Returns:

the class of the bean supported by this transform.

getDescription

public java.lang.String getDescription()

Returns the textual description of the transform

Specified by:

getDescription in interface Transform

Returns:

the description of the transform

transformForRequestSuccessful

public void transformForRequestSuccessful(MarkupOutput out)

Generates the graphical output for a ToolbarBean

Specified by:

transformForRequestSuccessful in class AbstractAppTransform

Parameters:

out - MarkupOutput instance where to create the HTML output

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

transformForRequestInError

public void transformForRequestInError(MarkupOutput out)

Description copied from class: AbstractAppTransform

Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestEndsInError. This method just calls AbstractAppTransform.displayError(com.microstrategy.web.beans.MarkupOutput, java.lang.String, java.lang.String, java.lang.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.

Overrides:

transformForRequestInError in class AbstractAppTransform

Parameters:

out - output by this transform

See Also:

AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)

renderQuickSearch

public void renderQuickSearch(MarkupOutput out)

getSearchEvent

protected WebEvent getSearchEvent()

getNewSearchEvent

protected WebEvent getNewSearchEvent()

renderPreContent

public void renderPreContent(MarkupOutput out)

renderSearchTextBox

public void renderSearchTextBox(MarkupOutput out)

renderPostContent

public void renderPostContent(MarkupOutput out)

getObjectTypes

protected java.lang.String getObjectTypes()

getPreferenceSharedReportsFolderID

protected java.lang.String getPreferenceSharedReportsFolderID()

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

getSysFolder

protected int getSysFolder()

getRootFolderId

protected java.lang.String getRootFolderId()