ECMFolderList

ECM Folder List

The ECM Folder List view displays (in tabular form) folders from the ECM content store. Events can be fired from user actions on the list, such as clicking on a folder. Folders can also be deleted from the list, if allowed through configuration.

Content management advanced

ECM server configuration name: The ECM server to use. The default server is the embedded ECM server. String

Folder path or ID: The default folder path is the root folder. String

Appearance

Table style: The style of the table.

Color style: The color style for the table display.

Max thumbnail size: The maximum size (in bytes) to display a thumbnail. Integer

Width: The width in pixels (px), percent (%), or em units (em). For example: 500px, 20%, 40em. If "px", "%", or "em" is not appended to the numeric value, the value defaults to "px". String

Height: The height in pixels (px), percent (%), or em units (em). For example: 500px, 20%, 40em. If "px", "%", or "em" is not appended to the numeric value, the value defaults to "px". String

Columns: The columns to display in the list. ECMFileListColumn[]

Behavior

Show footer: Show the table footer. Boolean

Show table stats: Show table statistics. For example, "Showing 1 to 5 of 59 entries". Boolean

Show pager: Display the pager. Boolean

Initial page size: The initial maximum number of entries shown for each page. Integer

Selection mode: Determines the selectability of table items.

Hide drill-up: Hide the folder drill-up table entry. Boolean

Content management

Allow document deletions: Enable files to be deleted using this control. Boolean

Confirm on deletion: Show a confirmation dialog box before files are deleted. Boolean

Events

On load:

Description: The logic that is called when the control is loaded. This event is only fired one time for each page load.

Example:

console.log(me.getFolderCount())

On folder clicked:

Description: This event is fired when a folder is clicked. Additional parameters: folder

Example:

window.open(url, '_blank');

Context Variables	folder {object}	Type	Description
Properties	id	String	The identifier of the folder
	name	String	The name of the folder
	path	String	The path of the folder

On folder deleted:

Description: This event is fired after a folder is deleted.

Example:

console.log('Folder Deleted.');

On refreshed:

Description: This event is fired when the folder table has been built.

Example:

console.log("Folder List refreshed")

On error:

Description: This event is fired when an error occurs during the execution of an operation. Additional parameters: message

Example:

alert("There has been an error : "+message)

Context Variables	message {string}

On row selected:

Description: This event is fired when a row is selected using a radio button or check box. Additional parameters passed: row

Example:

console.log("Folder Selected")

Context Variables	row {Object}

Extends:

com.ibm.bpm.coach.CoachView

Methods:

Inherited addClass(name, [replaced])

Add or replace the CSS classes for this view.

Name Type Default Description

name {string} The CSS class names to add to the view. For multiple classes, use space to separate the class names.

replaced {string} The CSS class names to be replaced by the first argument. For multiple classes, use space to separate the class names.

Example

Button.addClass("green");

clearAllSelection()

Deselects the selected records in the folder list.

createFolder(parentPath, name)

Creates a new folder under a specified parent folder path.

Name Type Default Description

parentPath {string} The parent folder path.

name {string} The name of the new folder.

Inherited getData() Returns: {Object}

Retrieve the bound data associated with the view. It applies only to views with bound data.

Example

var dec1 = MyDecimal.getData();

getFolderCount() Returns: {integer}

Returns the number of folders that are displayed in the list.

getFolderPath() Returns: {string}

Returns the folder path that is currently configred in the view.

getSelectedRecord() Returns: {Object}

Returns the folder record that is selected in the folder list.

getServerName() Returns: {string}

Returns the server name that is currently configured in the view.

getType() Returns: {string}

Returns the descriptive string that represents the control type.

Inherited hide(collapseFlag)

Hide the view.

Name Type Default Description

collapseFlag {boolean} Set to true to collapse the view (equivalent to a view setting of "NONE")

Example

MyView.hide();

Inherited isBound() Returns: {boolean}

Indicate the bound status of the view.

Inherited isEnabled() Returns: {boolean}

Check whether the view is enabled.

Example

var enabled = MyView.isEnabled();

Inherited isLabelVisible() Returns: {boolean}

Check whether the view label is visible.

Example

var labelVisible = MyView.isLabelVisible();

Inherited isValid() Returns: {boolean}

Return the valid status as last set by the setValid() method.

Example

var valid = MyView.isValid();

Inherited isVisible() Returns: {boolean}

Check whether the view is visible.

Example

var visible = MyView.isVisible();

Inherited propagateUpValueChange(event) Returns: {boolean}

Propagate the value change of the view up through the parent views.

Name Type Default Description

event {Event} Value change event (usually an onchange event)

Example

MyView.propagateUp(event);

Inherited recalculate()

Applicable only to formula-enabled views!
Triggers the re-evaluation of the formula
for the view, if a formula was specified. If the view is not formula-enabled, recalculate() does nothing.

Example

Text1.recalculate();
//If the formula for Text1 is: new Date().toString(), Text1 is updated to the current date/time

refresh()

Refreshes the content of the view.

search(searchText)

Searches for records that contain the specified search text.

Name Type Default Description

searchText {string} The search string.

selectRecordWithName(recordName)

Selects a folder record with the specified name.

Name Type Default Description

recordName {string} The name of the folder record to select.

Inherited setEnabled(enabled, required)

Enable or disable the view.

Name Type Default Description

enabled {boolean} Enabled/read-only flag (true to enable view, false to disable/make read-only)

required {boolean} Enable or disable the required field flag for the view.

Example

MyView.setEnabled(false); //Make MyView read-only

setFolderPath(path)

Sets the folder path for the view.

Name Type Default Description

path {string} The folder path.

Inherited setLabelVisible(visible)

Show or hide the view label.

Name Type Default Description

visible {boolean} Label visibility flag (true to show view label, false to hide)

Example

MyView.setLabelVisible(false);

setServerConfig(serverName, folderPath)

Sets the server name and folder path for the folder list.

Name Type Default Description

serverName {string} The server name.

folderPath {string} The folder path.

setTitle(title)

Sets the label of the underlying Table control.

Name Type Default Description

title {string} The new Table control label.

Inherited setValid(valid, errorText)

Flag the view as valid or invalid.

Name Type Default Description

valid {boolean} Valid/invalid flag (true to set view valid, false to make it invalid - which typically shows the view with "invalid" styling and indicator)

errorText {string} Validation error text to show on the invalid-styled view

Example

MyView.setValid(false, "Fix your data entry"); //Make MyView invalid

Inherited setViewData(data, createPseudoBinding)

Set or update the bound data associated with the view. It applies only to views with bound data.

Note: It should only be used with simple type bindings, or complex type bindings with simple type properties.
It should not be used with bindings that have properties that are lists or compext types. For complex types, set the bindings by using
the binding.set pattern, as described in the Binding data and configuration options documentation section.

Name Type Default Description

data {Object} The value of the bound data. The parameter type must match the type of the bound data.

createPseudoBinding {boolean} If the value is set to true, the parameter creates a pseudo binding if there is no current binding.

Example

MyView.setViewData("TEST"); //Updates bound data to the string 'TEST'

Inherited setVisible(visible, collapse)

Show or hide the view.

Name Type Default Description

visible {boolean} Visibility flag (true to show the view, false to hide it)

collapse {boolean} Set it to true to collapse the view space when the option visible is set to false.

Examples

MyView.setVisible(false, false); //Equivalent to MyView.hide()

MyView.setVisible(false, true); // Sets visibility to "None"

Inherited show()

Show this view.

Example

MyView.show();

sort(col, asc)

Sorts the folder list by the specified column name.

Name Type Default Description

col {string} The column name.

asc {boolean} Sorts the document list in ascending order in the column (when 'true').

Inherited triggerFormulaUpdates([phase])

Broadcast the expression trigger for the specified view.

Name Type Default Description

phase {int} bpmext.ui.PHASE_NORMAL The phase we are currently in

Example

MyView.triggerFormulaUpdates();

Methods

Parent

Helpers