org.dominokit.domino.ui.datatable.events.ColumnResizingEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-ui Show documentation
There is a newer version: 2.0.3
/*
 * Copyright © 2019 Dominokit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.dominokit.domino.ui.datatable.events;

import org.dominokit.domino.ui.datatable.ColumnConfig;

/**
 * This event will be fired when a column gets resized
 *
 * Event type: COLUMN_RESIZED -> 'column-resized'
 */
public class ColumnResizingEvent implements TableEvent {
  /** Constant COLUMN_RESIZED="column-resized" */
  public static final String COLUMN_RESIZING = "column-resizing";

  private final ColumnConfig column;
  private final double sizeDiff;
  private final boolean completed;

  /**
   * Factory method to create a new Event instance
   *
   * @param column a {@link ColumnConfig}
   * @param sizeDiff a double
   * @return a {@link ColumnResizingEvent}
   */
  public static ColumnResizingEvent of(ColumnConfig column, double sizeDiff) {
    return new ColumnResizingEvent(column, sizeDiff);
  }

  /**
   * Factory method to create a new Event instance
   *
   * @param column a {@link ColumnConfig}
   * @param sizeDiff a double
   * @param completed a boolean
   * @return a {@link ColumnResizingEvent}
   */
  public static ColumnResizingEvent of(ColumnConfig column, double sizeDiff, boolean completed) {
    return new ColumnResizingEvent(column, sizeDiff, completed);
  }

  /**
   * Creates a new Event instance
   *
   * @param column a {@link ColumnConfig}
   * @param sizeDiff a double
   */
  public ColumnResizingEvent(ColumnConfig column, double sizeDiff) {
    this(column, sizeDiff, false);
  }

  /**
   * Creates a new Event instance
   *
   * @param column a {@link ColumnConfig}
   * @param sizeDiff a double
   * @param completed a boolean
   */
  public ColumnResizingEvent(ColumnConfig column, double sizeDiff, boolean completed) {
    this.column = column;
    this.sizeDiff = sizeDiff;
    this.completed = completed;
  }

  /**
   * Getter for the field column.
   *
   * @return a {@link ColumnConfig}
   */
  public ColumnConfig getColumn() {
    return column;
  }

  /**
   * Getter for the field sizeDiff.
   *
   * @return a double
   */
  public double getSizeDiff() {
    return sizeDiff;
  }

  /**
   * isCompleted.
   *
   * @return a boolean
   */
  public boolean isCompleted() {
    return completed;
  }

  /** {@inheritDoc} */
  @Override
  public String getType() {
    return COLUMN_RESIZING;
  }
}