Merge branch 'w2p-65195_dynamic-component-refactoring' into clean-relationships-in-submission

src/app/shared/object-list/object-list.component.ts

@@ -16,6 +16,9 @@ import { DSpaceObject } from '../../core/shared/dspace-object.model';
 import { SearchResult } from '../search/search-result.model';
 import { SelectableListService } from './selectable-list/selectable-list.service';
 import { map, take, tap } from 'rxjs/operators';
+import { ViewMode } from '../../core/shared/view-mode.model';
+import { Context } from '../../core/shared/context.model';
+import { CollectionElementLinkType } from '../object-collection/collection-element-link.type';
 
 @Component({
   changeDetection: ChangeDetectionStrategy.Default,
@@ -26,10 +29,34 @@ import { map, take, tap } from 'rxjs/operators';
   animations: [fadeIn]
 })
 export class ObjectListComponent {
+  /**
+   * The view mode of the this component
+   */
+  viewMode = ViewMode.ListElement;
+
+  /**
+   * The current pagination configuration
+   */
   @Input() config: PaginationComponentOptions;
+
+  /**
+   * The current sort configuration
+   */
   @Input() sortConfig: SortOptions;
+
+  /**
+   * Whether or not the list elements have a border
+   */
   @Input() hasBorder = false;
+
+  /**
+   * The whether or not the gear is hidden
+   */
   @Input() hideGear = false;
+
+  /**
+   * Whether or not the pager is visible when there is only a single page of results
+   */
   @Input() hidePagerWhenSinglePage = true;
   @Input() selectable = false;
   @Input() selectionConfig: { repeatable: boolean, listId: string };
@@ -37,15 +64,32 @@ export class ObjectListComponent {
   // allSelected = false;
   // selectAllLoading = false;
 
+  /**
+   * The link type of the listable elements
+   */
+  @Input() linkType: CollectionElementLinkType;
+
+  /**
+   * The context of the listable elements
+   */
+  @Input() context: Context;
+
+  /**
+   * The current listable objects
+   */
   private _objects: RemoteData<PaginatedList<ListableObject>>;
 
-  constructor(protected selectionService: SelectableListService) {
-  }
-
+  /**
+   * Setter for the objects
+   * @param objects The new objects
+   */
   @Input() set objects(objects: RemoteData<PaginatedList<ListableObject>>) {
     this._objects = objects;
   }
 
+  /**
+   * Getter to return the current objects
+   */
   get objects() {
     return this._objects;
   }
@@ -80,6 +124,9 @@ export class ObjectListComponent {
    */
   @Output() sortDirectionChange: EventEmitter<SortDirection> = new EventEmitter<SortDirection>();
 
+  /**
+   * An event fired when on of the pagination parameters changes
+   */
   @Output() paginationChange: EventEmitter<any> = new EventEmitter<any>();
 
   @Output() deselectObject: EventEmitter<ListableObject> = new EventEmitter<ListableObject>();
@@ -90,24 +137,45 @@ export class ObjectListComponent {
    * Event's payload equals to the newly selected sort field.
    */
   @Output() sortFieldChange: EventEmitter<string> = new EventEmitter<string>();
-  data: any = {};
 
+  constructor(protected selectionService: SelectableListService) {
+  }
+
+  /**
+   * Emits the current page when it changes
+   * @param event The new page
+   */
   onPageChange(event) {
     this.pageChange.emit(event);
   }
 
+  /**
+   * Emits the current page size when it changes
+   * @param event The new page size
+   */
   onPageSizeChange(event) {
     this.pageSizeChange.emit(event);
   }
-
+  /**
+   * Emits the current sort direction when it changes
+   * @param event The new sort direction
+   */
   onSortDirectionChange(event) {
     this.sortDirectionChange.emit(event);
   }
 
+  /**
+   * Emits the current sort field when it changes
+   * @param event The new sort field
+   */
   onSortFieldChange(event) {
     this.sortFieldChange.emit(event);
   }
 
+  /**
+   * Emits the current pagination when it changes
+   * @param event The new pagination
+   */
   onPaginationChange(event) {
     this.paginationChange.emit(event);
   }