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

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

Public Constructors
	SearchSuggestTransform() Default no-args constructor, initialize formal parameters.

Public Methods
Map	addAttr(String name, int descId)
Map	addAttr(String name, String value)
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

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

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, int descId)

public Map addAttr (String name, String value)

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.

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.

Interfaces

Classes

SearchSuggestTransform

Class Overview

Summary

Fields

protected PageComponent _mstrPage

protected FormalParameter defaultRootFolderType

protected FormalParameter id

protected FormalParameter isMiniSearchBox

protected FormalParameter isServerSearch

protected FormalParameter showAsPopup

protected FormalParameter showSettings

protected FormalParameter showSuggestionAsPopup

Public Constructors

public SearchSuggestTransform ()

Public Methods

public Map addAttr (String name, int descId)

public Map addAttr (String name, String value)

public Map addTitleAttr (int descId)

public String getID ()

Returns

public void initializeTransform (Transformable data)

Parameters

public boolean isSettingVisible ()

public void renderJavaScriptFooter (MarkupOutput out)

Parameters

public void renderShell (MarkupOutput out)

Parameters

public void setObjectTypes (String value)

public void setRootFolderId (String value)

public void setSysFolder (String sysFolder)

See Also

public void transformForRequestSuccessful (MarkupOutput out)

Parameters

Protected Methods

protected Block createSearchBlock (MarkupOutput out)

Throws

protected String getObjectTypes ()

protected String getPreferenceSharedReportsFolderID ()

protected String getRootFolderId ()

protected int getSysFolder ()

protected void setBoneProperties (JsonGenerator boneProps)

Parameters