Class actuate.ReportExplorer

ReportExplorer class represents a ReportExplorer object.
Member of: actuate.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.ReportExplorer(container) Constructs a new ReportExplorer object.

Method Summary
Method Attributes	Method Name and Description
	getFolderName() Gets the folderName value for this report explorer.
	getLatestVersionOnly() Gets the latestVersionOnly value for this GetFolderItems.
	getResultDef() Gets the resultDef value for this GetFolderItems.
	getSearch() Gets the search value for this GetFolderItems.
	onUnload() unloads javascript variables that are no longer needed by reportexplorer
	registerEventHandler(eventName, handler) Register the event handler
	removeEventHandler(eventName, handler) Remove the event handler
	setContainer(containerID) Set the ID of the div container that Report Explorer should use
	setFolderName(folderName) Sets the folderName value for this report explorer
	setLatestVersionOnly(latestVersionOnly) Sets the latestVersionOnly value for this GetFolderItems.
	setResultDef(resultDef) Sets the resultDef value for this GetFolderItems.
	setSearch(search) Sets the search value for this GetFolderItems.
	setService(iportalURL, requestOptions) Set the iportal service this ReportExplorer component points to
	setStartingFolder(strfolderName) Sets the fully qualified path of the starting folder in the tree
	setUseDescriptionAsLabel(useDescription) Sets flag to use description of the file/folder as label in the Tree
	showFoldersOnly(flag) If this flag is set then the Report Explorer would disply only folders and no files.
	submit(callback) submit the report explorer page component request.

Class Detail

actuate.ReportExplorer(container)

Constructs a new ReportExplorer object.

Parameters:
{String} container: container object or name of a container in the current document

Method Detail

{String} getFolderName()

Gets the folderName value for this report explorer.

Returns:: {String} folderName

getLatestVersionOnly()

Gets the latestVersionOnly value for this GetFolderItems.

Returns:: latestVersionOnly {boolean}

getResultDef()

Gets the resultDef value for this GetFolderItems.

Returns:: resultDef {ArrayOfString} Array of Strings Possible values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", "PageCount"

getSearch()

Gets the search value for this GetFolderItems.

Returns:: search {FileSearch} Object of type actuate.reportexplorer.FileSearch

See:: actuate.reportexplorer.FileSearch

{void} onUnload()

unloads javascript variables that are no longer needed by reportexplorer

Returns:: {void}

{void} registerEventHandler(eventName, handler)

Parameters:
{String} eventName: Event name to capture.
{Function} handler: Where to pass control to, after fetching & rendering is done

Returns:: {void}

See:: actuate.reportexplorer.EventConstants for supported reportexplorer events

{void} removeEventHandler(eventName, handler)

Remove the event handler

Parameters:
{String} eventName: Event name to remove from the registered events.
{Function} handler: Handler function name to make sure that the correct eventName is being removed from the event handler.

Returns:: {void}

See:: actuate.reportexplorer.EventConstants for supported reportexplorer events

{void} setContainer(containerID)

Set the ID of the div container that Report Explorer should use

Parameters:
{String} containerID

Returns:: {void}

setFolderName(folderName)

Sets the folderName value for this report explorer

Parameters:
{String} folderName

{void} setLatestVersionOnly(latestVersionOnly)

Sets the latestVersionOnly value for this GetFolderItems.

Parameters:
latestVersionOnly: {boolean}

Returns:: {void}

setResultDef(resultDef)

Sets the resultDef value for this GetFolderItems.

Parameters:
resultDef: {ArrayOfString} Array Of Strings Possible values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", "PageCount"

{void} setSearch(search)

Sets the search value for this GetFolderItems.

Parameters:
search: {FileSearch} Object of type actuate.reportexplorer.FileSearch

Returns:: {void}

See:: actuate.reportexplorer.FileSearch

{void} setService(iportalURL, requestOptions)

Set the iportal service this ReportExplorer component points to

Parameters:
{String} iportalURL
{actuate.RequestOptions} requestOptions

Returns:: {void}

See:: actuate.RequestOptions

setStartingFolder(strfolderName)

Sets the fully qualified path of the starting folder in the tree

Parameters:
{String} strfolderName: - fully qualified path of the folder

setUseDescriptionAsLabel(useDescription)

Sets flag to use description of the file/folder as label in the Tree

Parameters:
{boolean} useDescription: - true or false

{void} showFoldersOnly(flag)

If this flag is set then the Report Explorer would disply only folders and no files.

Parameters:
{boolean} flag: = true / false

Returns:: {void}

{void} submit(callback)

submit the report explorer page component request. This api will download the folder items and then render the list of folder items to the container.

Parameters:

{Function} callback

The event handler takes the following arguments:

Where to pass control to, after fetching & rendering is done

Returns:: {void}

Classes

Class actuate.ReportExplorer