Class actuate.ReportExplorer

Represents a viewer for the contents of the file repository such as an iHub volume.
Member of: actuate.

Class Summary
Constructor Attributes	Constructor Name and Description
	actuate.ReportExplorer(container) Constructs a ReportExplorer object to view the contents of the file repository such as an iHub volume.

Method Summary
Method Attributes	Method Name and Description
	downloadFolderItems(folderPath, callBack) Returns an array list of FolderItems object based on the folder Name or folder id This method will send an AJAX GetFolderItems web service request to iPortal Sends an object of actuate.reportexplorer.FolderItems to the callBack function as an input argument
	getFolderItems(folderPath, callback) Download folder items for a specific directory and return the folder items to the callback provided.
	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) Submits the report explorer page component request.

Class Detail

actuate.ReportExplorer(container)

Constructs a ReportExplorer object to view the contents of the file repository such as an iHub volume.

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

Method Detail

{void} downloadFolderItems(folderPath, callBack)

Returns an array list of FolderItems object based on the folder Name or folder id This method will send an AJAX GetFolderItems web service request to iPortal Sends an object of actuate.reportexplorer.FolderItems to the callBack function as an input argument

Parameters:

{String} folderPath

- path of the folder whose items are to be fetched

{Function} callBack

- The callback takes the following arguments:

The function to call after the download of folder items is completed

Returns:: {void}

See:: actuate.reportexplorer.FolderItems

getFolderItems(folderPath, callback)

Download folder items for a specific directory and return the folder items to the callback provided.

Parameters:
folderPath: {String} - path of the folder whose items are to be fetched
callback: {Function} - callback function where the downloaded folder items are returned

{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. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount". iHub requires the Name, FileType, and Version fields in the results definition array to identify a file. This example sets the result set to five columns of data including name, file type, version, version name, and description:

	var resultDef = "Name|FileType|Version|VersionName|Description";
         myReportExplorer.setResultDef( resultDef.split("|") );

{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)

Submits the report explorer page component request. This method downloads the folder items and then renders 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