inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-1769] Added JSDoc for components (#2823)

Browse Source 
* [ADF-1769] Added JSDoc for components

* [ADF-1769] Fixed tslint error with trailing whitespace
This commit is contained in:
Andy Stark
2018-01-12 13:25:54 +00:00
committed by Eugenio Romano
parent f6cf036769
commit 72cfd7894d
4 changed files with 116 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
lib/process-services/task-list/components/task-list.component.ts
View File

@@ -36,48 +36,74 @@ export class TaskListComponent implements OnChanges, OnInit, AfterContentInit {
@ContentChild(DataColumnListComponent) columnList: DataColumnListComponent;
/* The id of the app. */
@Input()
appId: number;
/* The Instance Id of the process. */
@Input()
processInstanceId: string;
/* The Definition Key of the process. */
@Input()
processDefinitionKey: string;
/* Current state of the process. Possible values are: `completed`, `active`. */
@Input()
state: string;
/* The assignment of the process. Possible values are: "assignee" (the current user
* is the assignee), candidate (the current user is a task candidate", "group_x" (the task
* is assigned to a group where the current user is a member,
* no value(the current user is involved).
*/
@Input()
assignment: string;
/* Define the sort order of the processes. Possible values are : `created-desc`,
* `created-asc`, `due-desc`, `due-asc`
*/
@Input()
sort: string;
@Input()
name: string;
/* Define which task id should be selected after reloading. If the task id doesn't
* exist or nothing is passed then the first task will be selected.
*/
@Input()
landingTaskId: string;
/* Data source object that represents the number and the type of the columns that
* you want to show.
*/
@Input()
data: DataTableAdapter;
/* Row selection mode. Can be none, `single` or `multiple`. For `multiple` mode,
* you can use Cmd (macOS) or Ctrl (Win) modifier key to toggle selection for
* multiple rows.
*/
@Input()
selectionMode: string = 'single'; // none|single|multiple
@Input()
presetColumn: string;
/* Toggles multiple row selection, renders checkboxes at the beginning of each row */
@Input()
multiselect: boolean = false;
/* Emitted when a task in the list is clicked */
@Output()
rowClick: EventEmitter<string> = new EventEmitter<string>();
/* Emitted when rows are selected/unselected */
@Output()
rowsSelected: EventEmitter<any[]> = new EventEmitter<any[]>();
/* Emitted when the task list is loaded */
@Output()
success: EventEmitter<any> = new EventEmitter<any>();
@@ -88,9 +114,11 @@ export class TaskListComponent implements OnChanges, OnInit, AfterContentInit {
selectedInstances: any[];
layoutPresets = {};
/* The page number of the tasks to fetch. */
@Input()
page: number = 0;
/* The number of tasks to fetch. */
@Input()
size: number = DEFAULT_SIZE;