public class

SearchSimpleTransform

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.SearchSimpleTransform
Known Direct Subclasses

Class Overview

Transform for the search page

Summary

Constants
String CLASS_FOLDER_NAME
String CLASS_INVALID_FIELD
String CLASS_REQUIRED
String CLASS_SECTION_NAME
String DIV_DATES
String DIV_DESCRIPTION
String DIV_LOCATION
String DIV_LOCATION_TITLE
String DIV_NAME
String DIV_NAME_OPTIONS
String DIV_OWNER
String DIV_TYPES
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
public FormalParameter imgCalendar Specifies the image file name used by the transform to display the calendar button in DHTML mode.
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
SearchSimpleTransform()
Default no-args constructor, initialize formal parameters.
Public Methods
GGCalendar getCalendar(String imgCalendar)
getCalendar
String getDescription()
Returns a textual description of the transform.
Class getSupportedBeanType()
Returns the supported bean type.
boolean hasCurrentSearchFolder()
void initializeImages()
Initialize the images to be used by this transform.
void initializeTransform(Transformable data)

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

boolean isTypeSelected(int type)
void renderAdvancedNameSection(MarkupOutput out)
Renders the advanced search name input box including the string contraints dorpdown box.
void renderDateAdvancedFindAllObjectsWithSpecifiedDates(MarkupOutput out)
Renders the Find All Objects with Dates in Dates section
void renderDateForPreviousTimeUnits(MarkupOutput out)
Renders the "During Previous ## Hours/Days/Weeks/Months/Years"
void renderDateSimpleFindAllObject(MarkupOutput out)
Renders the simple option of find all objects without the specific dates
void renderDateStartAndEndDate(MarkupOutput out)
Renders the start date and end date
void renderDateTitle(MarkupOutput out)
Renders the title for dates section
void renderDatesSection(MarkupOutput out)
Renders the date section
void renderDescriptionSection(MarkupOutput out)
Renders the complete description section
void renderDescriptionTextArea(MarkupOutput out)
Renders the text area for description section
void renderDescriptionTitle(MarkupOutput out)
, Renders the description section title
void renderDivEnd(MarkupOutput out, String name)
Renders a transform's DIV tag end, i.e.: </DIV>
To work properly, the name argument must be one of the of the DIV_ constants of this transform.
void renderDivStart(MarkupOutput out, String name)
Renders a transform's DIV tag start.
void renderFieldName(MarkupOutput out, String field)
Renders the name of a search field.
void renderFieldName(MarkupOutput out, String field, String forField)
Renders the name of a search field.
void renderFindAllObjectsWithCreatedOrModified(MarkupOutput out)
Renders the advanced option for Find All Objects with the Created/Modified combo box
void renderFullAdvancedLocationSection(MarkupOutput out)
Renders the complete location section for advanced search
void renderFullSimpleLocationSection(MarkupOutput out)
Renders the complete location section for simple search
void renderImage(MarkupOutput out, String image)
Renders a transform's image
void renderJavaScriptFooter(MarkupOutput out)
Renders javascript variables at the bottom of the transform to be used in DHTML mode.
void renderLocationRadioButtons(MarkupOutput out)
Renders the available search locations as radio buttons
void renderLocationSection(MarkupOutput out)
This method is deprecated. Please use renderFullSimpleLocationSection or renderFullAdvancedLocationSection
void renderLocationTitle(MarkupOutput out)
Renders the location section with the horizontal divider i.e.
void renderNameSection(MarkupOutput out)
This method is deprecated. Please use renderSimpleNameSection or renderAdvancedNameSection
void renderNewSearchLink(MarkupOutput out)
Render a link that will clean the user's search criteria.
void renderOwnerCreatedByAnyUser(MarkupOutput out)
Renders the option of "created by any user" in the owner section
void renderOwnerCreatedOnlyByMe(MarkupOutput out)
Renders the option of "created only by me" in the owner secction
void renderOwnerSection(MarkupOutput out)
Renders the complete owner section
void renderOwnerTitle(MarkupOutput out)
Renders the owner section title
void renderProcessingButtons(MarkupOutput out)
Renders the buttons displayed to the end user when the request is still processing (for example, in the wait page).
void renderProcessingInfo(MarkupOutput out)
Transform when the status is "In Processing".
void renderRequiredLabelForSearchName(MarkupOutput out)
Renders the "Required" label for the search name
void renderSearchDetails(MarkupOutput out)
Displays the details of the criteria used for the search.
void renderSearchLocationAllFolders(MarkupOutput out)
Renders the search location option for all folders
void renderSearchLocationCurrentFolder(MarkupOutput out)
Renders the search location option for the current folder
void renderSearchLocationMyReportFolder(MarkupOutput out)
Renders the search location option for "my report" folder
void renderSearchLocationSharedReportsFolder(MarkupOutput out)
Renders the search location option for "Shared Report" folder
void renderSearchNameTextInputBox(MarkupOutput out)
Renders the search string input text box
void renderSearchNameTitle(MarkupOutput out)
Renders the title for the name section
void renderSearchObjectTypeCustomGroups(MarkupOutput out)
Renders the search object type option for filters
void renderSearchObjectTypeDocuments(MarkupOutput out)
Renders the search object type option for Documents
void renderSearchObjectTypeFilters(MarkupOutput out)
Renders the search object type option for filters
void renderSearchObjectTypeFolders(MarkupOutput out)
Renders the search object type option for folders
void renderSearchObjectTypeGroups(MarkupOutput out)
Renders the search object type option for groups
void renderSearchObjectTypeHTMLDocuments(MarkupOutput out)
Renders the search object type option for HTML Documents
void renderSearchObjectTypePrompts(MarkupOutput out)
Renders the search object type option for Documents
void renderSearchObjectTypeReports(MarkupOutput out)
Renders the search object type option for Reports
void renderSearchObjectTypeSecurityRoles(MarkupOutput out)
Renders the search object type option for security roles
void renderSearchObjectTypeShortcuts(MarkupOutput out)
Renders the search object type option for Documents
void renderSearchObjectTypeTemplates(MarkupOutput out)
Renders the search object type option for templates
void renderSearchObjectTypeUsers(MarkupOutput out)
Renders the search object type option for users
void renderSearchOptionsDerefrenceShortcut(MarkupOutput out)
, Renders the search option DerefrenceShortcut checkboxes
void renderSearchOptionsTitle(MarkupOutput out)
, Renders the search options section title
void renderSearchStringConstraintsComboBox(MarkupOutput out)
Renders the string constraints dropdown for the name section
void renderSearchTypeLink(MarkupOutput out)
void renderSimpleNameSection(MarkupOutput out)
Renders the search name input box without the string constraints drop down box, ie.contains, begins with and etc.
void renderSpanEnd(MarkupOutput out, String className)
Renders a transform's SPAN tag end, i.e.: </DIV >
void renderSpanStart(MarkupOutput out, String className)
Renders a transform's SPAN tag start.
void renderTypeTitle(MarkupOutput out)
Renders the type section title
void renderTypesSection(MarkupOutput out)
Renders the complete search type section
void transformForRequestSuccessful(MarkupOutput out)
Transform when the status is "Successful".
Protected Methods
AnchorTag generateAnchor(WebEvent event)
Creates an <a> tag from the EventManager.
WebEvent getCancelEvent()
WebEvent getNewSearchEvent()
WebEvent getRefreshEvent()
SearchBean getSearchBean()
WebEvent getSwitchSearchModeEvent()
void renderProcessingButton(MarkupOutput out, WebEvent event, String buttonDescriptor)
Overwrites the super's implementation to make the buttons on the wait page use Typical state.
[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

protected static final String CLASS_FOLDER_NAME

Constant Value: "mstrHighlighted"

protected static final String CLASS_INVALID_FIELD

Constant Value: "search-invlidField mstrStandardHighlighted"

protected static final String CLASS_REQUIRED

Constant Value: "search-required"

protected static final String CLASS_SECTION_NAME

Constant Value: "mstrTitle"

protected static final String DIV_DATES

Constant Value: "datesSection"

protected static final String DIV_DESCRIPTION

Constant Value: "descriptionSection"

protected static final String DIV_LOCATION

Constant Value: "locationSection"

protected static final String DIV_LOCATION_TITLE

Constant Value: "locationTitle"

protected static final String DIV_NAME

Constant Value: "nameSection"

protected static final String DIV_NAME_OPTIONS

Constant Value: "nameOptions"

protected static final String DIV_OWNER

Constant Value: "ownerSection"

protected static final String DIV_TYPES

Constant Value: "typesSection"

Fields

public FormalParameter imgCalendar

Specifies the image file name used by the transform to display the calendar button in DHTML mode.
This image should be contained in the images folder of the application.
Usage:
For example, if you want to specify a different image for the calendar button, you would need to copy it to the images folder and then specify its name in this formal parameter.

Public Constructors

public SearchSimpleTransform ()

Default no-args constructor, initialize formal parameters.

Public Methods

public GGCalendar getCalendar (String imgCalendar)

getCalendar

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public boolean hasCurrentSearchFolder ()

Returns
  • boolean

public void initializeImages ()

Initialize the images to be used 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 boolean isTypeSelected (int type)

public void renderAdvancedNameSection (MarkupOutput out)

Renders the advanced search name input box including the string contraints dorpdown box.

public void renderDateAdvancedFindAllObjectsWithSpecifiedDates (MarkupOutput out)

Renders the Find All Objects with Dates in Dates section

public void renderDateForPreviousTimeUnits (MarkupOutput out)

Renders the "During Previous ## Hours/Days/Weeks/Months/Years"

public void renderDateSimpleFindAllObject (MarkupOutput out)

Renders the simple option of find all objects without the specific dates

public void renderDateStartAndEndDate (MarkupOutput out)

Renders the start date and end date

public void renderDateTitle (MarkupOutput out)

Renders the title for dates section

public void renderDatesSection (MarkupOutput out)

Renders the date section

public void renderDescriptionSection (MarkupOutput out)

Renders the complete description section

public void renderDescriptionTextArea (MarkupOutput out)

Renders the text area for description section

public void renderDescriptionTitle (MarkupOutput out)

, Renders the description section title

public void renderDivEnd (MarkupOutput out, String name)

Renders a transform's DIV tag end, i.e.: </DIV>
To work properly, the name argument must be one of the of the DIV_ constants of this transform.

Parameters
out where to write the output of the method.
name the id to use with this div

public void renderDivStart (MarkupOutput out, String name)

Renders a transform's DIV tag start. For all tags it generates:
<DIV ID="name">
To work properly, the name argument must be one of the of the DIV_ constants of this transform.
DIV tags will not be rended in HTML only mode.

Parameters
out where to write the output of the method.
name the id to use with this div

public void renderFieldName (MarkupOutput out, String field)

Renders the name of a search field. This function checks if the field is valid and if it is required. To work properly, the className argument must be one of the of the SearchBeanFIELD_ constants.

Parameters
out where to write the output of the method.
field the field's name

public void renderFieldName (MarkupOutput out, String field, String forField)

Renders the name of a search field. This function checks if the field is valid and if it is required. To work properly, the className argument must be one of the of the SearchBeanFIELD_ constants.

Parameters
out where to write the output of the method.
field the field's name
forField the for attribute in the label *

public void renderFindAllObjectsWithCreatedOrModified (MarkupOutput out)

Renders the advanced option for Find All Objects with the Created/Modified combo box

public void renderFullAdvancedLocationSection (MarkupOutput out)

Renders the complete location section for advanced search

public void renderFullSimpleLocationSection (MarkupOutput out)

Renders the complete location section for simple search

public void renderImage (MarkupOutput out, String image)

Renders a transform's image

Parameters
out where to write the output of the method.
image the image name

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

Renders the available search locations as radio buttons

public void renderLocationSection (MarkupOutput out)

This method is deprecated.
Please use renderFullSimpleLocationSection or renderFullAdvancedLocationSection

Renders the location section

public void renderLocationTitle (MarkupOutput out)

Renders the location section with the horizontal divider i.e. used for advanced search form

public void renderNameSection (MarkupOutput out)

This method is deprecated.
Please use renderSimpleNameSection or renderAdvancedNameSection

Renders the name section

public void renderNewSearchLink (MarkupOutput out)

Render a link that will clean the user's search criteria.

public void renderOwnerCreatedByAnyUser (MarkupOutput out)

Renders the option of "created by any user" in the owner section

public void renderOwnerCreatedOnlyByMe (MarkupOutput out)

Renders the option of "created only by me" in the owner secction

public void renderOwnerSection (MarkupOutput out)

Renders the complete owner section

public void renderOwnerTitle (MarkupOutput out)

Renders the owner section title

public void renderProcessingButtons (MarkupOutput out)

Renders the buttons displayed to the end user when the request is still processing (for example, in the wait page). By default renders a "Check Status" button, associated with a EnumPageEvents.WebEventRefresh event, and a "Cancel this Request" buttons associated with a EnumServletEvents.WebEventCancel event.

Parameters
out output by this transform

public void renderProcessingInfo (MarkupOutput out)

Transform when the status is "In Processing".

Parameters
out output by this transform

public void renderRequiredLabelForSearchName (MarkupOutput out)

Renders the "Required" label for the search name

public void renderSearchDetails (MarkupOutput out)

Displays the details of the criteria used for the search.

Parameters
out output by this transform

public void renderSearchLocationAllFolders (MarkupOutput out)

Renders the search location option for all folders

public void renderSearchLocationCurrentFolder (MarkupOutput out)

Renders the search location option for the current folder

public void renderSearchLocationMyReportFolder (MarkupOutput out)

Renders the search location option for "my report" folder

public void renderSearchLocationSharedReportsFolder (MarkupOutput out)

Renders the search location option for "Shared Report" folder

public void renderSearchNameTextInputBox (MarkupOutput out)

Renders the search string input text box

public void renderSearchNameTitle (MarkupOutput out)

Renders the title for the name section

public void renderSearchObjectTypeCustomGroups (MarkupOutput out)

Renders the search object type option for filters

public void renderSearchObjectTypeDocuments (MarkupOutput out)

Renders the search object type option for Documents

public void renderSearchObjectTypeFilters (MarkupOutput out)

Renders the search object type option for filters

public void renderSearchObjectTypeFolders (MarkupOutput out)

Renders the search object type option for folders

public void renderSearchObjectTypeGroups (MarkupOutput out)

Renders the search object type option for groups

public void renderSearchObjectTypeHTMLDocuments (MarkupOutput out)

Renders the search object type option for HTML Documents

public void renderSearchObjectTypePrompts (MarkupOutput out)

Renders the search object type option for Documents

public void renderSearchObjectTypeReports (MarkupOutput out)

Renders the search object type option for Reports

public void renderSearchObjectTypeSecurityRoles (MarkupOutput out)

Renders the search object type option for security roles

public void renderSearchObjectTypeShortcuts (MarkupOutput out)

Renders the search object type option for Documents

public void renderSearchObjectTypeTemplates (MarkupOutput out)

Renders the search object type option for templates

public void renderSearchObjectTypeUsers (MarkupOutput out)

Renders the search object type option for users

public void renderSearchOptionsDerefrenceShortcut (MarkupOutput out)

, Renders the search option DerefrenceShortcut checkboxes

public void renderSearchOptionsTitle (MarkupOutput out)

, Renders the search options section title

public void renderSearchStringConstraintsComboBox (MarkupOutput out)

Renders the string constraints dropdown for the name section

public void renderSearchTypeLink (MarkupOutput out)

public void renderSimpleNameSection (MarkupOutput out)

Renders the search name input box without the string constraints drop down box, ie.contains, begins with and etc.

public void renderSpanEnd (MarkupOutput out, String className)

Renders a transform's SPAN tag end, i.e.: </DIV >

Parameters
out where to write the output of the method.
className the css class to use with this span

public void renderSpanStart (MarkupOutput out, String className)

Renders a transform's SPAN tag start. For all tags it generates:
<SPAN CLASS="className">
This method automatically adds the prefix to all the classNames.
To work properly, the className argument must be one of the of the CLASS_ constants of this transform.

Parameters
out where to write the output of the method.
className the css class to use with this span

public void renderTypeTitle (MarkupOutput out)

Renders the type section title

public void renderTypesSection (MarkupOutput out)

Renders the complete search type section

public void transformForRequestSuccessful (MarkupOutput out)

Transform when the status is "Successful".

Parameters
out output by this transform

Protected Methods

protected AnchorTag generateAnchor (WebEvent event)

Creates an <a> tag from the EventManager.

Parameters
event the WebEvent to generate the link with the request
Returns
  • AnchorTag instance initialized with the information from the event

protected WebEvent getCancelEvent ()

Returns
  • WebEvent instance initialized with the information for cancelling a request

protected WebEvent getNewSearchEvent ()

protected WebEvent getRefreshEvent ()

Returns
  • WebEvent instance initialized with the information for refreshing the request

protected SearchBean getSearchBean ()

protected WebEvent getSwitchSearchModeEvent ()

protected void renderProcessingButton (MarkupOutput out, WebEvent event, String buttonDescriptor)

Overwrites the super's implementation to make the buttons on the wait page use Typical state.

Parameters
out the output for the transform
event event for the button
buttonDescriptor the buton's descriptor