public abstract class

AbstractObjectExplorerTransform

extends AbstractEditorTransform
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.AbstractEditorTransform
           ↳ com.microstrategy.web.app.transforms.AbstractObjectExplorerTransform
Known Direct Subclasses
Known Indirect Subclasses

Summary

Constants
String FP_CHECK_IMAGE Name for the formal parameter: checkImage
String FP_DISPLAY_FORMAT_PICKER_NAME Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible display options.
String FP_INCREMENTAL_FETCH_NAV_TYPE Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch.
String FP_INCREMENTAL_FETCH_PAGE_BLOCK Name for the formal parameter: incrementalFetchPageBlock
String FP_SHOW_CURRENT_IN_ANCESTORS_LIST Name for the formal parameter: showCurrentInAncestorsList
String ID_POSTFIX
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String _imgCheck
protected ObjectExplorerBean _oeBean ObjectExplorerBean being transformed by this class
public FormalParameter checkImage Formal parameter: The icon to use to submit the parent folders select box in HTML mode.
public FormalParameter displayFormatPickerName Indicates the id of a system picker that contains the possible display options for the data result
protected FormalParameter incrementalFetchNavigationType Formal parameter that specifies which type of incremental fetch navigation will be enabled.
public FormalParameter incrementalFetchPageBlock Formal parameter: Indicates the number of pages to show per block for incremental fetch
public FormalParameter showCurrentInAncestorsList Formal parameter: Inidcates whether to show the current item in the ancestors list
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractObjectExplorerTransform()
Public Methods
String getDescription()
Return description for this Transform.
int getGoToArgument()
String getID()
This method overwrites its super implementation so that when assigning different styles to the same transform we get the same unique ID as long as the base bean stays the same
Map getUnitAttributes(WebDisplayUnit du)
Returns a map containing the attributes to add to the container of every object in the list of contents.
void initializeImages()
Initializes the name of the images to use on this transform's output.
void initializeTransform(Transformable data)
Initializes transform formal parameters
boolean isUseOptionTitle()
void renderAncestors(MarkupOutput out)
Renders a select box containing a list of the folder's ancestors
void renderChangeFormatDropDown(MarkupOutput out)
Method that renders the "show as" display option
void renderDisplayFormatPickers(MarkupOutput out)
Method that renders the display format pickers
void renderEditorContents(MarkupOutput out)
Method that renders the editor contents corresponding to this Wizard.
void renderErrorMessage(MarkupOutput out)
void renderHiddenInputs(MarkupOutput out)
Renders the hidden inputs of the events that can be handled by the bean
void renderIncrementalFetch(MarkupOutput out)
Renders the incremental fetch section of the component
void renderLayeredIconInfo(MarkupOutput out, WebDisplayUnit unit)
generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
void renderObjectCount(MarkupOutput out)
Renders the total number of objects contianed by the component, regardless of any incremental fetch functionality
void renderOpenParent(MarkupOutput out)
Renders a link to the folder's parent
void renderSearch(MarkupOutput out)
Renders the search section of the component
void renderSearchBox(MarkupOutput out)
Renders the search box for the project browser
void renderSearchButton(MarkupOutput out)
Renders a Magnifier image as the search/filter button of the browser
void renderUnit(MarkupOutput out, WebDisplayUnit du)
Returns the give unit in the component's contents list.
void setUseOptionTitle(boolean useTitle)
boolean shouldDisplayErrorMessage()
Protected Methods
StringBuffer addAncestorsOptionsToSelectTag(SelectTag tag)
void addCurrentFolderToAncestorList(SelectTag tag, StringBuffer indentBuffer)
void addOpenParentImg(Tag tag)
void addOpenParentImg(Tag tag, boolean enabled)
ArrayList getAncestorsOptionTags(StringBuffer indentBuffer)
SelectTag getAncestorsSelectTag()
Returns a >select< Tag instance object containing the list\ of the object's ancestors
int getBlockPosition()
int getBlockSize()
WebEvent getBrowseEvent()
Returns a new instance of the event use for browsing across objects
WebEvent getChangeDisplayFormatEvent()
Returns a new instance of the event use to toggle the display format
int getChildCount()
abstract String getCssName(WebDisplayUnit du)
Retruns the css class to use on the container of the object presented in the list of contents.
ClientSideHelper getExplorerClientSideHelper()
Returns a the client side helper object that will be associated with the list ob objects to display.
String getExplorerScriptClass()
Returns the javaScript class (bone) associated with the content's list.
Tag getForm(Tag content)
The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form.
ArrayList getHiddenInputsEventList()
Returns the list of events that will be included in the hidden inputs section.
IncrementalFetch getIncrementalFetchComponent()
Generate and initialize the IncrementalFetch component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.
WebEvent getOKEvent()
Returns a new instance of the event use for the ok button
WebEvent getOpenParentEvent()
Returns a new instance of the event use to go to open the object's parent
Tag getOption(WebDisplayUnit du, String indent)
Returns an option Tag containing the display unit provided.
Tag getSearchBox()
Returns the search box for the project browser MarkupOutput
Tag getSearchButton()
Returns a Magnifier image as the search/filter button of the browser MarkupOutput
WebEvent getSearchEvent()
Returns a new instance of the event use for searching objects in the Explorer
AnchorTag getUnitAnchor(WebDisplayUnit du)
Returns an >a< Tag instance that will allow th euser to "open" the given unit in the component.
String getUnitDesc(WebDisplayUnit du)
Get the
String getUnitName(WebDisplayUnit du)
Renders only the name of the object passed as a parameter
void renderSearchEventArgs(MarkupOutput out)
Render hidden inputs for Search event arguments
boolean shouldGenerateNewForm()
boolean shouldShowDummyFolderOption()
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractEditorTransform
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_CHECK_IMAGE

Name for the formal parameter: checkImage

Constant Value: "checkImage"

public static final String FP_DISPLAY_FORMAT_PICKER_NAME

Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible display options. Value is displayFormatPickerId.

Constant Value: "displayFormatPickerName"

public static final String FP_INCREMENTAL_FETCH_NAV_TYPE

Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch. Value is incrementalFetchNavigationType.

Constant Value: "incrementalFetchNavigationType"

public static final String FP_INCREMENTAL_FETCH_PAGE_BLOCK

Name for the formal parameter: incrementalFetchPageBlock

Constant Value: "incrementalFetchPageBlock"

public static final String FP_SHOW_CURRENT_IN_ANCESTORS_LIST

Name for the formal parameter: showCurrentInAncestorsList

Constant Value: "showCurrentInAncestorsList"

protected static final String ID_POSTFIX

Constant Value: "_display"

Fields

protected String _imgCheck

protected ObjectExplorerBean _oeBean

ObjectExplorerBean being transformed by this class

public FormalParameter checkImage

Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image

public FormalParameter displayFormatPickerName

Indicates the id of a system picker that contains the possible display options for the data result

protected FormalParameter incrementalFetchNavigationType

Formal parameter that specifies which type of incremental fetch navigation will be enabled. Allowed values: a valid bitwise combination of NAVIGATION_BUTTONS_FIRST_LAST and/or NAVIGATION_BUTTONS_PREVIOUS_NEXT

public FormalParameter incrementalFetchPageBlock

Formal parameter: Indicates the number of pages to show per block for incremental fetch

public FormalParameter showCurrentInAncestorsList

Formal parameter: Inidcates whether to show the current item in the ancestors list

Public Constructors

public AbstractObjectExplorerTransform ()

Public Methods

public String getDescription ()

Return description for this Transform.

Returns
  • description text.

public int getGoToArgument ()

public String getID ()

This method overwrites its super implementation so that when assigning different styles to the same transform we get the same unique ID as long as the base bean stays the same

Returns
  • String the unqiue ID used by the place-holder DIV when doing iframe update.

public Map getUnitAttributes (WebDisplayUnit du)

Returns a map containing the attributes to add to the container of every object in the list of contents.

Parameters
du WebDisplayUnit
Returns
  • Map

public void initializeImages ()

Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.

public void initializeTransform (Transformable data)

Initializes transform formal parameters

Parameters
data Transformable instance to be associated with this transform.

public boolean isUseOptionTitle ()

public void renderAncestors (MarkupOutput out)

Renders a select box containing a list of the folder's ancestors

Parameters
out MarkupOutput

public void renderChangeFormatDropDown (MarkupOutput out)

Method that renders the "show as" display option

Parameters
out MarkupOutput instance where the HTML contents to render are to be saved.

public void renderDisplayFormatPickers (MarkupOutput out)

Method that renders the display format pickers

Parameters
out MarkupOutput instance where the HTML contents to render are to be saved.

public void renderEditorContents (MarkupOutput out)

Method that renders the editor contents corresponding to this Wizard.

Parameters
out MarkupOutput instance where the HTML contents to render are to be saved.

public void renderErrorMessage (MarkupOutput out)

public void renderHiddenInputs (MarkupOutput out)

Renders the hidden inputs of the events that can be handled by the bean

Parameters
out MarkupOutput

public void renderIncrementalFetch (MarkupOutput out)

Renders the incremental fetch section of the component

Parameters
out MarkupOutput

public void renderLayeredIconInfo (MarkupOutput out, WebDisplayUnit unit)

generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).

Parameters
out MarkupOutput instance where to save the contents to display
unit WebDisplayUnit to be rendered.

public void renderObjectCount (MarkupOutput out)

Renders the total number of objects contianed by the component, regardless of any incremental fetch functionality

Parameters
out MarkupOutput

public void renderOpenParent (MarkupOutput out)

Renders a link to the folder's parent

Parameters
out MarkupOutput

public void renderSearch (MarkupOutput out)

Renders the search section of the component

Parameters
out MarkupOutput

public void renderSearchBox (MarkupOutput out)

Renders the search box for the project browser

Parameters
out MarkupOutput

public void renderSearchButton (MarkupOutput out)

Renders a Magnifier image as the search/filter button of the browser

Parameters
out MarkupOutput

public void renderUnit (MarkupOutput out, WebDisplayUnit du)

Returns the give unit in the component's contents list.

Parameters
out MarkupOutput
du WebDisplayUnit

public void setUseOptionTitle (boolean useTitle)

public boolean shouldDisplayErrorMessage ()

Protected Methods

protected StringBuffer addAncestorsOptionsToSelectTag (SelectTag tag)

protected void addCurrentFolderToAncestorList (SelectTag tag, StringBuffer indentBuffer)

protected void addOpenParentImg (Tag tag)

protected void addOpenParentImg (Tag tag, boolean enabled)

protected ArrayList getAncestorsOptionTags (StringBuffer indentBuffer)

protected SelectTag getAncestorsSelectTag ()

Returns a >select< Tag instance object containing the list\ of the object's ancestors

Returns
  • SelectTag

protected int getBlockPosition ()

protected int getBlockSize ()

protected WebEvent getBrowseEvent ()

Returns a new instance of the event use for browsing across objects

Returns
  • WebEvent

protected WebEvent getChangeDisplayFormatEvent ()

Returns a new instance of the event use to toggle the display format

Returns
  • WebEvent

protected int getChildCount ()

protected abstract String getCssName (WebDisplayUnit du)

Retruns the css class to use on the container of the object presented in the list of contents.

Parameters
du WebDisplayUnit
Returns
  • String

protected ClientSideHelper getExplorerClientSideHelper ()

Returns a the client side helper object that will be associated with the list ob objects to display. Note this is different from the getClientSideHelper() method which returns the ClientSideHelper instance for the entire component object.

Returns
  • ClientSideHelper

protected String getExplorerScriptClass ()

Returns the javaScript class (bone) associated with the content's list.

Returns
  • String

protected Tag getForm (Tag content)

The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form. If the formal parameter is set to false, the method return the same tag passed as parameter.

Parameters
content Tag
Returns
  • Tag

protected ArrayList getHiddenInputsEventList ()

Returns the list of events that will be included in the hidden inputs section.

Returns
  • ArrayList

protected IncrementalFetch getIncrementalFetchComponent ()

Generate and initialize the IncrementalFetch component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.

Returns

protected WebEvent getOKEvent ()

Returns a new instance of the event use for the ok button

Returns
  • WebEvent

protected WebEvent getOpenParentEvent ()

Returns a new instance of the event use to go to open the object's parent

Returns
  • WebEvent

protected Tag getOption (WebDisplayUnit du, String indent)

Returns an option Tag containing the display unit provided.

Parameters
du WebDisplayUnit to open
indent String

protected Tag getSearchBox ()

Returns the search box for the project browser MarkupOutput

protected Tag getSearchButton ()

Returns a Magnifier image as the search/filter button of the browser MarkupOutput

protected WebEvent getSearchEvent ()

Returns a new instance of the event use for searching objects in the Explorer

Returns
  • WebEvent

protected AnchorTag getUnitAnchor (WebDisplayUnit du)

Returns an >a< Tag instance that will allow th euser to "open" the given unit in the component. This method is used in the component's contents list.

Parameters
du WebDisplayUnit
Returns
  • AnchorTag

protected String getUnitDesc (WebDisplayUnit du)

Get the

Parameters
du WebDisplayUnit

protected String getUnitName (WebDisplayUnit du)

Renders only the name of the object passed as a parameter

Parameters
du WebDisplayUnit

protected void renderSearchEventArgs (MarkupOutput out)

Render hidden inputs for Search event arguments

protected boolean shouldGenerateNewForm ()

protected boolean shouldShowDummyFolderOption ()