Methods

addClass
getData
getRevisionsService
getServerName
getType
getVersionCount
hide
isBound
isEnabled
isLabelVisible
isValid
isVisible
propagateUpValueChange
queryDocumentVersions
recalculate
refresh
setEnabled
setLabel
setLabelVisible
setValid
setViewData
setVisible
show
triggerFormulaUpdates

Parent

CoachView

Helpers

bpmext.log
bpmext.number
bpmext.text
bpmext.ui
bpmext.ui.View
bpmext.ui.util
ECM File Revisions
The ECM File Revisions view displays (in tabular form) revisions of an ECM file/document given the id of that document. Events can be fired from user actions on the list, such as clicking on a file.
Content management advanced
ECM server configuration name: The ECM server to use. The default server is the embedded ECM server. String
Appearance
Table style: The style of the table.
Color style: The color style for the table display.
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
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.getVersionCount())
On file clicked:
Description: This event is fired when a file is clicked. Additional parameters: doc
Example: 
window.open(url, '_blank');
Context Variables url {string} doc {object} Type Description
Properties id String The identifier of the document
fileName String The file name of the document
versionLabel String The version number of the document
url String The url of the document that can be used to download the document content
On refreshed:
Description: This event is fired when the file table has been built.
Example: 
console.log("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 with the refresh")
Extends:
com.ibm.bpm.coach.CoachView
Methods:
Inherited addClass(name, [replaced])
Add or replace the CSS classes for this view.
NameTypeDefaultDescription
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");
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();
getRevisionsService() Returns: {com.ibm.bpm.coach.CoachView}
Returns the view of the GetAllVersions service call.
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.
getVersionCount() Returns: {integer}
Returns the number of documents that are loaded in the list.
Inherited hide(collapseFlag)
Hide the view.
NameTypeDefaultDescription
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.
NameTypeDefaultDescription
event{Event}Value change event (usually an onchange event)
Example
MyView.propagateUp(event);
queryDocumentVersions(id)
Retrieves all revisions for the specified document or version series ID.
NameTypeDefaultDescription
id{string}The document or version series ID.
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 list.
Inherited setEnabled(enabled, required)
Enable or disable the view.
NameTypeDefaultDescription
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
setLabel(label)
Sets the label of the control.
NameTypeDefaultDescription
label{string}The label of the control.
Inherited setLabelVisible(visible)
Show or hide the view label.
NameTypeDefaultDescription
visible{boolean}Label visibility flag (true to show view label, false to hide)
Example
MyView.setLabelVisible(false);
Inherited setValid(valid, errorText)
Flag the view as valid or invalid.
NameTypeDefaultDescription
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.
NameTypeDefaultDescription
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.
NameTypeDefaultDescription
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();
Inherited triggerFormulaUpdates([phase])
Broadcast the expression trigger for the specified view.
NameTypeDefaultDescription
phase{int}bpmext.ui.PHASE_NORMALThe phase we are currently in
Example
MyView.triggerFormulaUpdates();