kanbanworkflowstimelinescrumrubyroadmapproject-planningproject-managementopenprojectangularissue-trackerifcgantt-chartganttbug-trackerboardsbcf
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
429 lines
15 KiB
429 lines
15 KiB
// -- copyright
|
|
// OpenProject is a project management system.
|
|
// Copyright (C) 2012-2015 the OpenProject Foundation (OPF)
|
|
//
|
|
// This program is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License version 3.
|
|
//
|
|
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
|
// Copyright (C) 2006-2013 Jean-Philippe Lang
|
|
// Copyright (C) 2010-2013 the ChiliProject Team
|
|
//
|
|
// This program is free software; you can redistribute it and/or
|
|
// modify it under the terms of the GNU General Public License
|
|
// as published by the Free Software Foundation; either version 2
|
|
// of the License, or (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program; if not, write to the Free Software
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
//
|
|
// See doc/COPYRIGHT.rdoc for more details.
|
|
// ++
|
|
|
|
import {Moment} from 'moment';
|
|
import {openprojectModule} from '../../../../angular-modules';
|
|
import {scopeDestroyed$} from '../../../../helpers/angular-rx-utils';
|
|
import {debugLog, timeOutput} from '../../../../helpers/debug_output';
|
|
import {TypeResource} from '../../../api/api-v3/hal-resources/type-resource.service';
|
|
import {WorkPackageResourceInterface} from '../../../api/api-v3/hal-resources/work-package-resource.service';
|
|
import {States} from '../../../states.service';
|
|
import {WorkPackageNotificationService} from '../../../wp-edit/wp-notification.service';
|
|
import {RenderedRow} from '../../../wp-fast-table/builders/primary-render-pass';
|
|
import {WorkPackageTableHierarchiesService} from '../../../wp-fast-table/state/wp-table-hierarchy.service';
|
|
import {WorkPackageTableTimelineService} from '../../../wp-fast-table/state/wp-table-timeline.service';
|
|
import {WorkPackageTable} from '../../../wp-fast-table/wp-fast-table';
|
|
import {WorkPackageTableTimelineState} from '../../../wp-fast-table/wp-table-timeline';
|
|
import {WorkPackageRelationsService} from '../../../wp-relations/wp-relations.service';
|
|
|
|
import {selectorTimelineSide} from '../../wp-table-scroll-sync';
|
|
import {WorkPackagesTableController} from '../../wp-table.directive';
|
|
import {WorkPackageTimelineCell} from '../cells/wp-timeline-cell';
|
|
import {WorkPackageTimelineCellsRenderer} from '../cells/wp-timeline-cells-renderer';
|
|
import {
|
|
calculateDaySpan,
|
|
getPixelPerDayForZoomLevel,
|
|
timelineElementCssClass,
|
|
timelineLeftSpacingInDays,
|
|
timelineMarkerSelectionStartClass,
|
|
TimelineViewParameters,
|
|
zoomLevelOrder
|
|
} from '../wp-timeline';
|
|
import moment = require('moment');
|
|
|
|
|
|
export class WorkPackageTimelineTableController {
|
|
|
|
public wpTableDirective:WorkPackagesTableController;
|
|
|
|
public workPackageTable:WorkPackageTable;
|
|
|
|
private _viewParameters:TimelineViewParameters = new TimelineViewParameters();
|
|
|
|
public disableViewParamsCalculation = false;
|
|
|
|
public workPackageIdOrder:RenderedRow[] = [];
|
|
|
|
private renderers:{ [name:string]:(vp:TimelineViewParameters) => void } = {};
|
|
|
|
private cellsRenderer = new WorkPackageTimelineCellsRenderer(this);
|
|
|
|
public outerContainer:JQuery;
|
|
|
|
public timelineBody:JQuery;
|
|
|
|
private selectionParams = {
|
|
notification: null
|
|
};
|
|
|
|
private text:{ selectionMode:string };
|
|
|
|
private debouncedRefresh:() => any;
|
|
|
|
constructor(private $scope:angular.IScope,
|
|
private $element:angular.IAugmentedJQuery,
|
|
private states:States,
|
|
private NotificationsService:any,
|
|
private wpTableTimeline:WorkPackageTableTimelineService,
|
|
private wpNotificationsService:WorkPackageNotificationService,
|
|
private wpRelations:WorkPackageRelationsService,
|
|
private wpTableHierarchies:WorkPackageTableHierarchiesService,
|
|
private I18n:op.I18n) {
|
|
'ngInject';
|
|
}
|
|
|
|
$onInit() {
|
|
this.text = {
|
|
selectionMode: this.I18n.t('js.timelines.selection_mode.notification')
|
|
};
|
|
|
|
// Get the outer container for width computation
|
|
this.outerContainer = this.$element.find('.wp-table-timeline--outer');
|
|
this.timelineBody = this.$element.find('.wp-table-timeline--body');
|
|
|
|
// Debounced refresh function
|
|
this.debouncedRefresh = _.debounce(
|
|
() => {
|
|
debugLog('Refreshing view in debounce.');
|
|
this.refreshView();
|
|
},
|
|
500,
|
|
{leading: true}
|
|
);
|
|
|
|
// Register this instance to the table
|
|
this.wpTableDirective.registerTimeline(this, this.timelineBody[0]);
|
|
|
|
// Refresh on changes to work packages
|
|
this.updateOnWorkPackageChanges();
|
|
|
|
// Refresh timeline view after table rendered
|
|
this.states.table.rendered.values$()
|
|
.takeUntil(this.states.table.stopAllSubscriptions)
|
|
.filter(() => this.initialized)
|
|
.subscribe((orderedRows) => {
|
|
// Remember all visible rows in their order of appearance.
|
|
this.workPackageIdOrder = orderedRows.filter(row => !row.hidden);
|
|
this.refreshView();
|
|
});
|
|
|
|
this.states.table.timelineAutoZoom.values$()
|
|
.takeUntil(this.states.table.stopAllSubscriptions)
|
|
.filter(() => this.initialized)
|
|
.filter((enabled:boolean) => enabled)
|
|
.subscribe(() => {
|
|
this.refreshView();
|
|
});
|
|
|
|
// Refresh timeline view when becoming visible
|
|
this.states.table.timelineVisible.values$()
|
|
.filter((timelineState:WorkPackageTableTimelineState) => timelineState.isVisible)
|
|
.takeUntil(scopeDestroyed$(this.$scope))
|
|
.subscribe((timelineState:WorkPackageTableTimelineState) => {
|
|
this.viewParameters.settings.zoomLevel = timelineState.zoomLevel;
|
|
this.debouncedRefresh();
|
|
});
|
|
|
|
// Load the types whenever the timeline is first visible
|
|
// TODO: Load only necessary types from API
|
|
this.states.table.timelineVisible.values$()
|
|
.filter((timelineState) => timelineState.isVisible)
|
|
.take(1)
|
|
.subscribe(() => {
|
|
TypeResource.loadAll().then(() => {
|
|
this.debouncedRefresh();
|
|
});
|
|
});
|
|
}
|
|
|
|
workPackageInView(wpId:string):boolean {
|
|
return this.cellsRenderer.hasCell(wpId);
|
|
}
|
|
|
|
workPackageCells(wpId:string):WorkPackageTimelineCell[] {
|
|
return this.cellsRenderer.getCellsFor(wpId);
|
|
}
|
|
|
|
/**
|
|
* Return the index of a given row by its class identifier
|
|
*/
|
|
workPackageIndex(classIdentifier:string):number {
|
|
return this.workPackageIdOrder.findIndex((el) => el.classIdentifier === classIdentifier);
|
|
}
|
|
|
|
onRefreshRequested(name:string, callback:(vp:TimelineViewParameters) => void) {
|
|
this.renderers[name] = callback;
|
|
}
|
|
|
|
getAbsoluteLeftCoordinates():number {
|
|
return this.$element.offset().left;
|
|
}
|
|
|
|
getParentScrollContainer() {
|
|
return this.outerContainer.closest(selectorTimelineSide)[0];
|
|
}
|
|
|
|
get viewParameters():TimelineViewParameters {
|
|
return this._viewParameters;
|
|
}
|
|
|
|
get inHierarchyMode():boolean {
|
|
return this.wpTableHierarchies.isEnabled;
|
|
}
|
|
|
|
get initialized():boolean {
|
|
return this.workPackageTable && this.states.table.rendered.hasValue();
|
|
}
|
|
|
|
refreshView() {
|
|
if (!this.wpTableTimeline.isVisible) {
|
|
debugLog('refreshView() requested, but TL is invisible.');
|
|
return;
|
|
}
|
|
|
|
timeOutput('refreshView() in timeline container', () => {
|
|
// Reset the width of the outer container if its content shrinks
|
|
this.outerContainer.css('width', 'auto');
|
|
|
|
if (this.states.table.timelineAutoZoom.value!) {
|
|
this.applyAutoZoomLevel();
|
|
}
|
|
|
|
this.calculateViewParams(this._viewParameters);
|
|
|
|
// Update all cells
|
|
this.cellsRenderer.refreshAllCells();
|
|
|
|
_.each(this.renderers, (cb, key) => {
|
|
debugLog(`Refreshing timeline member ${key}`);
|
|
cb(this._viewParameters);
|
|
});
|
|
|
|
// Calculate overflowing width to set to outer container
|
|
// required to match width in all child divs
|
|
const currentWidth = this.getParentScrollContainer().scrollWidth;
|
|
this.outerContainer.width(currentWidth);
|
|
});
|
|
}
|
|
|
|
updateOnWorkPackageChanges() {
|
|
this.states.workPackages.observeChange()
|
|
.withLatestFrom(this.states.table.timelineVisible.values$())
|
|
.takeUntil(scopeDestroyed$(this.$scope))
|
|
.filter(([, timelineState]) => this.initialized && timelineState.isVisible)
|
|
.map(([[wpId]]) => wpId)
|
|
.filter((wpId) => this.cellsRenderer.hasCell(wpId))
|
|
.subscribe((wpId) => {
|
|
const viewParamsChanged = this.calculateViewParams(this._viewParameters);
|
|
if (viewParamsChanged) {
|
|
this.debouncedRefresh();
|
|
} else {
|
|
// Refresh the single cell
|
|
this.cellsRenderer.refreshCellsFor(wpId);
|
|
}
|
|
});
|
|
}
|
|
|
|
startAddRelationPredecessor(start:WorkPackageResourceInterface) {
|
|
this.activateSelectionMode(start.id, end => {
|
|
this.wpRelations
|
|
.addCommonRelation(start as any, 'follows', end.id)
|
|
.catch((error:any) => this.wpNotificationsService.handleErrorResponse(error, end));
|
|
});
|
|
}
|
|
|
|
startAddRelationFollower(start:WorkPackageResourceInterface) {
|
|
this.activateSelectionMode(start.id, end => {
|
|
this.wpRelations
|
|
.addCommonRelation(start as any, 'precedes', end.id)
|
|
.catch((error:any) => this.wpNotificationsService.handleErrorResponse(error, end));
|
|
});
|
|
}
|
|
|
|
getFirstDayInViewport() {
|
|
const outerContainer = this.getParentScrollContainer();
|
|
const scrollLeft = outerContainer.scrollLeft;
|
|
const nonVisibleDaysLeft = Math.floor(scrollLeft / this.viewParameters.pixelPerDay);
|
|
return this.viewParameters.dateDisplayStart.clone().add(nonVisibleDaysLeft, 'days');
|
|
}
|
|
|
|
getLastDayInViewport() {
|
|
const outerContainer = this.getParentScrollContainer();
|
|
const scrollLeft = outerContainer.scrollLeft;
|
|
const width = outerContainer.offsetWidth;
|
|
const viewPortRight = scrollLeft + width;
|
|
const daysUntilViewPortEnds = Math.ceil(viewPortRight / this.viewParameters.pixelPerDay) + 1;
|
|
return this.viewParameters.dateDisplayStart.clone().add(daysUntilViewPortEnds, 'days');
|
|
}
|
|
|
|
forceCursor(cursor:string) {
|
|
jQuery('.' + timelineElementCssClass).css('cursor', cursor);
|
|
jQuery('.wp-timeline-cell').css('cursor', cursor);
|
|
jQuery('.hascontextmenu').css('cursor', cursor);
|
|
jQuery('.leftHandle').css('cursor', cursor);
|
|
jQuery('.rightHandle').css('cursor', cursor);
|
|
}
|
|
|
|
resetCursor() {
|
|
jQuery('.' + timelineElementCssClass).css('cursor', '');
|
|
jQuery('.wp-timeline-cell').css('cursor', '');
|
|
jQuery('.hascontextmenu').css('cursor', '');
|
|
jQuery('.leftHandle').css('cursor', '');
|
|
jQuery('.rightHandle').css('cursor', '');
|
|
}
|
|
|
|
private resetSelectionMode() {
|
|
this._viewParameters.activeSelectionMode = null;
|
|
this._viewParameters.selectionModeStart = null;
|
|
|
|
this.NotificationsService.remove(this.selectionParams.notification);
|
|
|
|
Mousetrap.unbind('esc');
|
|
|
|
this.$element.removeClass('active-selection-mode');
|
|
jQuery('.' + timelineMarkerSelectionStartClass).removeClass(timelineMarkerSelectionStartClass);
|
|
this.refreshView();
|
|
}
|
|
|
|
private activateSelectionMode(start:string, callback:(wp:WorkPackageResourceInterface) => any) {
|
|
start = start.toString(); // old system bug: ID can be a 'number'
|
|
|
|
this._viewParameters.activeSelectionMode = (wp:WorkPackageResourceInterface) => {
|
|
callback(wp);
|
|
this.resetSelectionMode();
|
|
};
|
|
|
|
this._viewParameters.selectionModeStart = start;
|
|
Mousetrap.bind('esc', () => this.resetSelectionMode());
|
|
this.selectionParams.notification = this.NotificationsService.addNotice(this.text.selectionMode);
|
|
|
|
this.$element.addClass('active-selection-mode');
|
|
this.refreshView();
|
|
}
|
|
|
|
private calculateViewParams(currentParams:TimelineViewParameters):boolean {
|
|
if (this.disableViewParamsCalculation) {
|
|
return false;
|
|
}
|
|
|
|
const newParams = new TimelineViewParameters();
|
|
let changed = false;
|
|
|
|
// Calculate view parameters
|
|
this.workPackageIdOrder.forEach((renderedRow) => {
|
|
const wpId = renderedRow.workPackageId;
|
|
|
|
// Not all rendered rows are work packages
|
|
if (!wpId || this.states.workPackages.get(wpId).isPristine()) {
|
|
return;
|
|
}
|
|
|
|
// We may still have a reference to a row that, e.g., just got deleted
|
|
const workPackage = this.states.workPackages.get(wpId).value!;
|
|
const startDate = workPackage.startDate ? moment(workPackage.startDate) : currentParams.now;
|
|
const dueDate = workPackage.dueDate ? moment(workPackage.dueDate) : currentParams.now;
|
|
const date = workPackage.date ? moment(workPackage.date) : currentParams.now;
|
|
|
|
// start date
|
|
newParams.dateDisplayStart = moment.min(
|
|
newParams.dateDisplayStart,
|
|
currentParams.now,
|
|
startDate,
|
|
date);
|
|
|
|
// due date
|
|
newParams.dateDisplayEnd = moment.max(
|
|
newParams.dateDisplayEnd,
|
|
currentParams.now,
|
|
dueDate,
|
|
date);
|
|
});
|
|
|
|
// left spacing
|
|
newParams.dateDisplayStart.subtract(timelineLeftSpacingInDays, 'days');
|
|
|
|
// right spacing
|
|
const width = this.$element.width();
|
|
const pixelPerDay = currentParams.pixelPerDay;
|
|
const visibleDays = Math.ceil((width / pixelPerDay) * 1.5);
|
|
newParams.dateDisplayEnd.add(visibleDays, 'days');
|
|
|
|
// Check if view params changed:
|
|
|
|
// start date
|
|
if (!newParams.dateDisplayStart.isSame(this._viewParameters.dateDisplayStart)) {
|
|
changed = true;
|
|
this._viewParameters.dateDisplayStart = newParams.dateDisplayStart;
|
|
}
|
|
|
|
// end date
|
|
if (!newParams.dateDisplayEnd.isSame(this._viewParameters.dateDisplayEnd)) {
|
|
changed = true;
|
|
this._viewParameters.dateDisplayEnd = newParams.dateDisplayEnd;
|
|
}
|
|
|
|
// Calculate the visible viewport
|
|
const firstDayInViewport = this.getFirstDayInViewport();
|
|
const lastDayInViewport = this.getLastDayInViewport();
|
|
const viewport:[Moment, Moment] = [firstDayInViewport, lastDayInViewport];
|
|
this._viewParameters.visibleViewportAtCalculationTime = viewport;
|
|
|
|
return changed;
|
|
}
|
|
|
|
private applyAutoZoomLevel() {
|
|
const daysSpan = calculateDaySpan(this.workPackageIdOrder, this.states.workPackages);
|
|
const timelineWidthInPx = this.outerContainer.width();
|
|
|
|
for (let zoomLevel of zoomLevelOrder) {
|
|
const pixelPerDay = getPixelPerDayForZoomLevel(zoomLevel);
|
|
const visibleDays = timelineWidthInPx / pixelPerDay;
|
|
|
|
if (visibleDays >= daysSpan || zoomLevel === _.last(zoomLevelOrder)) {
|
|
// Zoom level is enough
|
|
const previousZoomLevel = this._viewParameters.settings.zoomLevel;
|
|
|
|
// did the zoom level changed?
|
|
if (previousZoomLevel !== zoomLevel) {
|
|
this.wpTableTimeline.setZoomLevel(zoomLevel);
|
|
this.wpTableDirective.timeline.scrollLeft = 0;
|
|
}
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
openprojectModule.component('wpTimelineContainer', {
|
|
controller: WorkPackageTimelineTableController,
|
|
templateUrl: '/components/wp-table/timeline/container/wp-timeline-container.html',
|
|
require: {
|
|
wpTableDirective: '^wpTable'
|
|
}
|
|
});
|
|
|