Script Extensions

Class: Row

otris.scriptlist. Row

This class represents a Row used in a otris.scriptlist.List.
You do not need to instantiate objects of this class directly. Instances of
this class are returned from the addRow
method of the List object.

Constructors

Methods

addSubrow(config){otris.scriptlist.Subrow}

Add a subrow to display as a sublist after the last grid column.
This can also be used to add documents that will be opened on click on a certain file.

Name Type Description
config string | object

String if only value should be displayed or Object for further configuration.

Name Type Description
icons Array.<string>

Array of icons to be used for the subrow. Currently only the first icon is displayed.
documentName string

full document name to be displayed if referenced subrow is a file document. This is only needed if thumbnails are created automatically based on these paremeters.
extension string

Extension of the document to be used as automatically generate file type icon. This is only needed if thumbnails are created automatically based on these paremeters.
size string

Size to be displayed on hover thumbnail icon, with unit (e.g. byte). This is only needed if thumbnails are created automatically based on these paremeters.
onclick string

Javascript Code to be executed if the subrow was clicked.
values Array.<string>

0 :name to be displayed
1 :size filesize to be displayed if list is displayed as blobthumbnails
  • Since:
    • Documents 5.0e
Returns:
Type Description
otris.scriptlist.Subrow

setAction(newAction)

Action which will be fired when the row is clicked.
Available actions: showFile, showFolder, runScript

Name Type Description
newAction string

function to be executed on mouse click
Example
listRow.setAction("showFile:" + myFileId);

setDetailsParams(detailsParams)

Set the row specific parameters that should be send to the details script when expanding
the details row. Overwrites the parameters set in the list.

Name Type Description
detailsParams Object

key/value object of parameters to pass to the details script

setDetailsScriptName(detailsScriptName)

Set the row specific name of the script that is called when the rows details row will be expanded.
(Overwrites the scriptName set in the list).

Name Type Description
detailsScriptName string

the scriptname to use for displaying the details row

setEmphasized(emphasized)

Mark the row as emphasized. Shown with bold text in the list.

Name Type Description
emphasized boolean

emphasized flag
  • Since:
    • Documents 5.0e

setOnClick(newOnclick)

Set handler for click event.

Name Type Description
newOnclick String

function as string to be executed on mouse click

setOnDoubleClick(newOnDoubleclick)

Set handler for double click event.

Name Type Description
newOnDoubleclick String

function as string to be executed on mouse double click

setSelected(selected)

Checks the row on display

Name Type Description
selected Boolean

True if row should be selected in view

setTag(tag)

Tag the row with a predefined grey marker or insert custom html

Name Type Description
tag boolean | string

True for a standard grey marker, String for HTML

setTagColor(tagColor)

Set the tag color

Name Type Description
tagColor string

Html color for the row's tag

transfer(){Object}

Transfer function returning the data of the Row for a gadget.

Returns:
Type Description
Object Data of the row