de.knightsoftnet.mtwidgets.client.event.ListPositionChangeEvent Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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 de.knightsoftnet.mtwidgets.client.event;

import de.knightsoftnet.mtwidgets.client.event.ListPositionChangeEvent.ListPositionChangeHandler;

import com.google.gwt.editor.client.Editor;
import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HasHandlers;
import com.google.web.bindery.event.shared.HandlerRegistration;

/**
 * event which can be thrown by a list editor entry to inform about it's movement.
 *
 * @param  type of the Event
 *
 * @author Manfred Tremmel
 *
 */
public class ListPositionChangeEvent extends GwtEvent> {
  private static final Type> TYPE = new Type<>();

  public enum ListPositionEnum {
    UP, // one position up
    DOWN, // one position down
    ABSOLUTE // move to the given position
  }

  public interface ListPositionChangeHandler extends EventHandler {
    void onListPositionChange(ListPositionChangeEvent event);
  }

  public interface ListPositionChangeHandlers extends HasHandlers {
    HandlerRegistration addListPositionChangeHandler(ListPositionChangeHandler handler);
  }

  private final Editor editor;
  private final ListPositionEnum positionChange;
  private final int newPosition;

  public ListPositionChangeEvent(final Editor peditor, final ListPositionEnum ppositionChange) {
    this(peditor, ppositionChange, -1);
  }

  /**
   * constructor.
   *
   * @param peditor editor widget in the list
   * @param ppositionChange enum of change
   * @param pnewPosition new position for absolute changes
   */
  public ListPositionChangeEvent(final Editor peditor, final ListPositionEnum ppositionChange,
      final int pnewPosition) {
    super();
    this.editor = peditor;
    positionChange = ppositionChange;
    newPosition = pnewPosition;
  }

  public static Type> getType() {
    return ListPositionChangeEvent.TYPE;
  }

  @Override
  protected void dispatch(final ListPositionChangeHandler handler) {
    handler.onListPositionChange(this);
  }

  @SuppressWarnings({"rawtypes", "unchecked"})
  @Override
  public Type> getAssociatedType() {
    return (Type) ListPositionChangeEvent.TYPE;
  }

  public Editor getEditor() {
    return editor;
  }

  public final ListPositionEnum getPositionChange() {
    return positionChange;
  }

  public final int getNewPosition() {
    return newPosition;
  }
}