Class actuate.ReportExplorerThe actuate.ReportExplorer class retrieves and displays a navigable repository or file system interface that enables users to navigate folders and select files. This generic user interface enables the user to browse and select repository contents.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.Table 4-38 lists actuate.ReportExplorer functions.
Table 4-38 submit( ) string[ ] ReportExplorer.getResultDef( )Array of strings. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount".This example sets the FileSearch setting for reportexplorer1 to the FileSearch settings of reportexplorer2:Registers an event handler to activate for parameter eventName. This function can assign several handlers to a single event.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.This example registers the errorHandler( ) function to respond to the ON_EXCEPTION event:myReportExplorer.registerEventHandler(actuate.ReportExplorer.EventConstants.ON_EXCEPTION, errorHandler);This example removes the errorHandler( ) function from responding to the ON_EXCEPTION event:myReportExplorer.removeEventHandler(actuate.ReportExplorer.EventConstants.ON_EXCEPTION, errorHandler);String. The name of the HTML element that displays the group of rendered ReportExplorer components.String. The name of the repository folder to use as the root folder. Use a repository path to use subfolders for the root folder.void ReportExplorer.setResultDef(string[ ] resultDef)Array of strings. Valid values are: "Name", "FileType", "Version", "VersionName", "Description", "Timestamp", "Size", and "PageCount".This example sets the result set to five columns of data including name, file type, version, version name, and description:This example sets the FileSearch setting for reportexplorer1 to the FileSearch settings of reportexplorer2: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.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.myExplorer.setService("http://localhost:8700/iportal", myRequestOptions);myExplorer.setStartingFolder("C:\Program Files\Actuate11\iServer\servletcontainer\iportal\WEB-INF\repository\Public");Submits requests to the server for 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.This example submits ReportExplorer with a root folder that set with setStartingFolder( ) and result definition set with setResultDef( ):
|
|
Copyright Actuate Corporation 2012 |