openproject/frontend/app/components/wp-fast-table/state/wp-table-timeline.service.ts

// -- 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 {opServicesModule} from '../../../angular-modules';
import {QueryResource, TimelineLabels, TimelineZoomLevel} from '../../api/api-v3/hal-resources/query-resource.service';
import {WorkPackageResourceInterface} from '../../api/api-v3/hal-resources/work-package-resource.service';
import {States} from '../../states.service';
import {zoomLevelOrder} from '../../wp-table/timeline/wp-timeline';
import {WorkPackageTableTimelineState} from './../wp-table-timeline';
import {TableStateStates, WorkPackageQueryStateService, WorkPackageTableBaseService} from './wp-table-base.service';

export class WorkPackageTableTimelineService extends WorkPackageTableBaseService implements WorkPackageQueryStateService {

  protected stateName = 'timelineVisible' as TableStateStates;

  constructor(public states:States) {
    super(states);
  }

  public initialize(query:QueryResource) {
    let current = new WorkPackageTableTimelineState(query);

    this.state.putValue(current);
  }

  public hasChanged(query:QueryResource) {
    const visibilityChanged = this.isVisible !== query.timelineVisible;
    const zoomLevelChanged = this.zoomLevel !== query.timelineZoomLevel;
    const labelsChanged = !_.isEqual(this.current.labels, query.timelineLabels);

    return visibilityChanged || zoomLevelChanged || labelsChanged;
  }

  public applyToQuery(query:QueryResource) {
    query.timelineVisible = this.isVisible;
    query.timelineZoomLevel = this.zoomLevel;
    query.timelineLabels = this.current.labels;

    return false;
  }

  public toggle() {
    let currentState = this.current;

    currentState.toggle();

    this.state.putValue(currentState);
  }

  public get isVisible() {
    return this.current.isVisible;
  }

  public get zoomLevel() {
    return this.current.zoomLevel;
  }

  public get labels() {
    if (_.isEmpty(this.current.labels)) {
      return this.current.defaultLabels;
    }

    return this.current.labels;
  }

  public updateLabels(labels:TimelineLabels) {
    let currentState = this.current;
    currentState.labels = labels;
    this.state.putValue(currentState);
  }

  public getNormalizedLabels(workPackage:WorkPackageResourceInterface) {
    let labels:TimelineLabels = _.clone(this.current.defaultLabels);

    _.each(this.current.labels, (attribute:string, position:keyof TimelineLabels) => {
      // Set to null to explicitly disable
      if (attribute === '') {
        labels[position] = null;
      } else {
        labels[position] = attribute;
      }
    });

    return labels;
  }

  public setZoomLevel(level:TimelineZoomLevel) {
    let currentState = this.current;
    currentState.zoomLevel = level;
    this.state.putValue(currentState);
  }

  public updateZoomWithDelta(delta:number) {
    if (this.isAutoZoomEnabled()) {
      this.toggleAutoZoom();
    }

    let idx = zoomLevelOrder.indexOf(this.current.zoomLevel);
    idx += delta;

    if (idx >= 0 && idx < zoomLevelOrder.length) {
      this.setZoomLevel(zoomLevelOrder[idx]);
    }
  }

  public toggleAutoZoom() {
    this.states.table.timelineAutoZoom.putValue(!this.states.table.timelineAutoZoom.value);
  }

  public isAutoZoomEnabled():boolean {
    return this.states.table.timelineAutoZoom.value!;
  }

  public get current():WorkPackageTableTimelineState {
    return this.state.value as WorkPackageTableTimelineState;
  }

}

opServicesModule.service('wpTableTimeline', WorkPackageTableTimelineService);