Class actuate.ReportExplorer
Description
The actuate.ReportExplorer class retrieves and displays a navigable repository or file system interface that enables users to navigate folders and select files. This is a generic UI that enables the user to browse and select repository contents.
Constructor
Syntax
Constructs a ReportExplorer object for a page, initializing the reportexplorer component.
Parameters
String. The name of the HTML element that displays the rendered reportexplorer component or a container object. The constructor initializes the reportexplorer component but does not render it.
Function summary
Table 4-32 lists actuate.ReportExplorer functions.
actuate.ReportExplorer.getFolderName
Syntax
Returns the name of the root folder for this reportexplorer.
Returns
Example
This example displays the root folder’s name in an alert box.
actuate.ReportExplorer.getLatestVersionOnly
Syntax
Returns the latest version only flag for this reportexplorer.
Returns
Example
This example displays the latest version only flag in an alert box.
actuate.ReportExplorer.getResultDef
Syntax
string[ ] ReportExplorer.getResultDef( )Returns the results definition.
Returns
Array of Strings. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount"
Example
This example displays the results definition an alert box.
actuate.ReportExplorer.getSearch
Syntax
Returns the FileSearch object assigned to this report explorer.
Returns
actuate.reportexplorer.FileSearch object.
Example
This example sets the FileSearch setting for reportexplorer1 to the FileSearch settings of reportexplorer2.
actuate.ReportExplorer.onUnload
Syntax
Unloads javascript variables that are no longer needed by reportexplorer
Example
This example cleans up unused JavaScript variables for myReportExplorer.
actuate.ReportExplorer.registerEventHandler
Syntax
Registers an event handler to activate for parameter eventName. This function can assign several handlers to a single event.
Parameters
String. Event name to capture.
Function. The function to execute when the event occurs. The handler must take two arguments: the ReportExplorer instance that fired the event and an event object specific to the event type.
Example
This example registers the errorHandler( ) function to respond to the ON_EXCEPTION event.
myReportExplorer.registerEventHandler(actuate.ReportExplorer.EventConstants.ON_EXCEPTION, errorHandler);actuate.ReportExplorer.removeEventHandler
Syntax
Removes an event handler to activate for parameter eventName.
Parameters
String. Event name to remove from the internal list of registered events.
Function. The function to disable.
Example
This example removes the errorHandler( ) function from responding to the ON_EXCEPTION event.
myReportExplorer.removeEventHandler(actuate.ReportExplorer.EventConstants.ON_EXCEPTION, errorHandler);actuate.ReportExplorer.setContainer
Syntax
Sets the HTML element container for the reportexplorer content.
Parameters
String. The name of the HTML element that displays the group of rendered reportexplorer components.
Example
This example sets MyReportExplorer to render the <div> element labeled "History".
actuate.ReportExplorer.setFolderName
Syntax
Sets the name of the root folder for this reportexplorer.
Parameters
String. The name of the repository folder to use as the root folder. Use a repository path to use subfolders for the root folder.
Example
This example sets the report explorer root folder to /Public.
actuate.ReportExplorer.setLatestVersionOnly
Syntax
Sets the latest version only flag for this reportexplorer.
Parameters
Boolean. True removes all but the latest versions from the report explorer.
Example
This example sets report explorer to display only the latest versions of all files.
actuate.ReportExplorer.setResultDef
Syntax
void ReportExplorer.setResultDef(string[ ] resultDef)Parameters
Array of Strings. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount"
Example
This example sets the result set to 5 columns of data including name, file type, version, version name, and description.
actuate.ReportExplorer.setSearch
Syntax
Sets a FileSearch object assigned to this report explorer.
Parameters
actuate.reportexplorer.FileSearch object.
Example
This example sets the FileSearch setting for reportexplorer1 to the FileSearch settings of reportexplorer2.
actuate.ReportExplorer.setService
Syntax
Sets the target service URL to which this explorer links. When the service URL is not set, this viewer links to the default service URL which is set on the actuate object.
Parameters
String. The target Actuate web application URL, either a Java Component or Information Console.
actuate.RequestOptions object. Optional. RequestOptions defines URL parameters to send with the authentication request, such as the iServer URL, Encyclopedia volume, or repository type. The URL can also include custom parameters.
Example
This example sets the URL for the Actuate iPortal web application service.
myExplorer.setService("http://localhost:8700/iportal", myRequestOptions);actuate.ReportExplorer.setStartingFolder
Syntax
Sets the fully qualified path of the initially selected folder in the explorer tree.
Parameters
String. The fully qualified path of a folder.
Example
This example sets the initially selected folder to Public in the local repository.
myExplorer.setStartingFolder("C:\Program Files\Actuate11\iServer\servletcontainer\iportal\WEB-INF\repository\Public");actuate.ReportExplorer.setUseDescriptionAsLabel
Syntax
Sets the explorer to display the folder description as the folder label instead of the folder name.
Parameters
Boolean. True displays descriptions for folders instead of folder names.
Example
This example displays descriptions for folders instead of folder names.
actuate.ReportExplorer.showFoldersOnly
Syntax
Sets the Report Explorer to display folders but not files.
Parameters
Boolean. True displays folders but not files.
Example
This example displays folders in the report explorer but not files.
actuate.ReportExplorer.submit
Syntax
Submits requests to the server for the reportexplorer. When this function is called, an AJAX request is triggered to submit all the operations. When the server finishes the processing, it returns a response and the results are rendered on the page in the reportexplorer container.
Parameters
Function. The function to execute after the asynchronous call processing is done.
Example
This example submits the reportexplorer with a root folder that set with setStartingFolder( ) and result definition set with setResultDef( ).
| (c) Copyright Actuate Corporation 2011 |
|