public class

FolderCreateDocumentTransform

extends FolderCreateReportXHTMLTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
           ↳ com.microstrategy.web.app.transforms.AbstractFolderTransform
             ↳ com.microstrategy.web.app.transforms.FolderIconRadioButtonTransform
               ↳ com.microstrategy.web.app.transforms.FolderCreateReportXHTMLTransform
                 ↳ com.microstrategy.web.app.transforms.FolderCreateDocumentTransform
Known Direct Subclasses

Class Overview

This class extends the FolderCreateReportXHTMLTransform by specializing in showing the new document folder content. It has two sections, showing the blank document on top, and on the bottom the rest of the items on the folder.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.FolderCreateReportXHTMLTransform
From class com.microstrategy.web.app.transforms.FolderIconRadioButtonTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.FolderCreateReportXHTMLTransform
From class com.microstrategy.web.app.transforms.FolderIconRadioButtonTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
FolderCreateDocumentTransform()
Default no-argument constructor.
Public Methods
boolean hasCreateBlankObjectPrivileges()
Determines if the user has enough privileges for viewing the blank report option with this transform
void initializeTransform(Transformable data)
Extends the parent method by searching for the blank report within the content of the folder, as specified on the blankObjectId formal parameter.
boolean isEmptyList(WebDisplayUnits list)
This method is deprecated. please use isEmptyList() instead, where the list to be analyzed is the one obtained from getSortedChildUnits().
boolean isEmptyList()
Returns true if the list of elements from this folder available for display (getSortedList()) is empty or not.
void renderButtonOptions(MarkupOutput out)
Overwrites the original method.
void renderDashboardObject(MarkupOutput out, WebObjectInfo object)
void renderObject(MarkupOutput out, WebObjectInfo object)
Renders the WebObjectInfo object requested according to the specifications of this transform.
Protected Methods
String getArgumentName(WebEvent event, int argumentID)
For the given event, returns the name of the argument with the given ID.
WebEvent getOpenObjectEvent()
Overwrites the original method for returning the WebEventEditRW event instead.
void renderDesignModeOption(MarkupOutput out, WebEvent createEvent, boolean designMode)
Render a check box giving the option to have the object selected run in design mode.
void renderFormInputInfo(MarkupOutput out, WebEvent openEvent)
Render any hidden input information that has to be added while displaying the contents in the folder, according with the WebEvent specified.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.FolderCreateReportXHTMLTransform
From class com.microstrategy.web.app.transforms.FolderIconRadioButtonTransform
From class com.microstrategy.web.app.transforms.AbstractFolderTransform
From class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
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

Public Constructors

public FolderCreateDocumentTransform ()

Default no-argument constructor. Initializes formal parameters.

Public Methods

public boolean hasCreateBlankObjectPrivileges ()

Determines if the user has enough privileges for viewing the blank report option with this transform

Returns
  • boolean value indicating if the blank object should be available to the user or not.

public void initializeTransform (Transformable data)

Extends the parent method by searching for the blank report within the content of the folder, as specified on the blankObjectId formal parameter.

Parameters
data Transformable instance with the bean to be transformed.

public boolean isEmptyList (WebDisplayUnits list)

This method is deprecated.
please use isEmptyList() instead, where the list to be analyzed is the one obtained from getSortedChildUnits().

Indicates if there will be objects to display from the instance sent in as parameter. The check by default is the count of document objects included on the list.

Parameters
list WebDisplayUnits list instance initialized with the objects to render
Returns
  • boolean value indicating if there are objects to be displayed out of this list.

public boolean isEmptyList ()

Returns true if the list of elements from this folder available for display (getSortedList()) is empty or not.

Returns
  • true if the underlying object list is empty.

public void renderButtonOptions (MarkupOutput out)

Overwrites the original method. By default the option available is to run the object in design mode.

Parameters
out MarkupOutput where the HTML output will be saved

public void renderDashboardObject (MarkupOutput out, WebObjectInfo object)

public void renderObject (MarkupOutput out, WebObjectInfo object)

Renders the WebObjectInfo object requested according to the specifications of this transform.
Builds a series of DIV tags where the information coming from the renderObjectImage(MarkupOutput, WebObjectInfo), renderObjectName(MarkupOutput, WebObjectInfo) and renderObjectDescription(MarkupOutput, WebObjectInfo) methods generate.

Parameters
out MarkupOutput instance where to save the contents to display
object WebObjectInfo to be rendered.

Protected Methods

protected String getArgumentName (WebEvent event, int argumentID)

For the given event, returns the name of the argument with the given ID. When overriding an specific getEvent method, clients can override this method as well to provide the corresponding argument for the new event. Since the getOpenObjectEvent() method was redefined, this method is also updated for returning the correct object identifier argument from it.

Parameters
event WebEvent from which retrieve the argument
argumentID argument Id from where to get its name.
Returns
  • the argument name as defined by the event.

protected WebEvent getOpenObjectEvent ()

Overwrites the original method for returning the WebEventEditRW event instead.

Returns
  • a WebEvent instance intialized if the application supports it. Otherwise, returns null

protected void renderDesignModeOption (MarkupOutput out, WebEvent createEvent, boolean designMode)

Render a check box giving the option to have the object selected run in design mode. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Parameters
out MarkupOutput where the HTML output will be saved
createEvent WebEvent representing the action to do with the given object
designMode boolean indicating if design mode is selected.

protected void renderFormInputInfo (MarkupOutput out, WebEvent openEvent)

Render any hidden input information that has to be added while displaying the contents in the folder, according with the WebEvent specified. If the event has been customized, then this method should also be overwritten for the event argument identifiers to be correct.

Parameters
out MarkupOutput where the HTML output will be saved
openEvent WebEvent representing the action to do with the given object