org.arakhne.afc.ui.actionmode.SelectableInteractionEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of base Show documentation
There is a newer version: 13.0
/* 
 * $Id: org/arakhne/afc/ui/actionmode/SelectableInteractionEvent.java v12.0 2015-04-09 01:26:18$
 * 
 * Copyright (C) 2002 Stephane GALLAND, Madhi HANNOUN, Marc BAUMGARTNER.
 * Copyright (C) 2012-13 Stephane GALLAND.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * This program is free software; you can redistribute it and/or modify
 */
package org.arakhne.afc.ui.actionmode ;

import java.util.Collection;
import java.util.Collections;
import java.util.EventObject;

import org.arakhne.afc.ui.event.KeyEvent;
import org.arakhne.afc.ui.selection.Selectable;

/** Describes the interaction event.
 *
 * @author Stéphane GALLAND
 * @version 12.0 2015-04-09 01:26:18
 * @mavengroupid org.arakhne.afc.ui
 * @mavenartifactid base
 */
public class SelectableInteractionEvent extends EventObject {

	private static final long serialVersionUID = -1039544916556548342L;

	private final Collection figures;
	private boolean consumed = false;
	private final ActionPointerEvent pointerEvent;
	private final KeyEvent keyEvent;
	private final boolean isEditable;
	
	/**
	 * @param manager
	 * @param figure
	 * @param isEditable
	 */
	public SelectableInteractionEvent(ActionModeManager manager, Collection figure, boolean isEditable) {
		super(manager);
		this.figures = figure==null ? Collections.emptyList() : figure;
		this.pointerEvent = null;
		this.keyEvent = null;
		this.isEditable = isEditable;
	}

	/**
	 * @param manager
	 * @param figure
	 * @param pointerEvent
	 * @param isEditable
	 */
	public SelectableInteractionEvent(ActionModeManager manager, Collection figure, ActionPointerEvent pointerEvent, boolean isEditable) {
		super(manager);
		this.figures = figure==null ? Collections.emptyList() : figure;
		this.pointerEvent = pointerEvent;
		this.keyEvent = null;
		this.isEditable = isEditable;
	}

	/**
	 * @param manager
	 * @param figure
	 * @param keyEvent
	 * @param isEditable
	 */
	public SelectableInteractionEvent(ActionModeManager manager, Collection figure, KeyEvent keyEvent, boolean isEditable) {
		super(manager);
		this.figures = figure==null ? Collections.emptyList() : figure;
		this.pointerEvent = null;
		this.keyEvent = keyEvent;
		this.isEditable = isEditable;
	}

	/** Replies if the editor on which the interaction occured enables the edition
	 * of the figures.
	 * 
	 * @return true if the viewer is editable; otherwise false.
	 */
	public boolean isEditable() {
		return this.isEditable;
	}
	
	/**
	 * Replies the figure on which the event occured.
	 * 
	 * @return the figures, never null.
	 * @see #getSelectable()
	 */
	public Collection getSelectables() {
		return Collections.unmodifiableCollection(this.figures);
	}
	
	/**
	 * Replies one of the figures on which the event occured.
	 * The method of selection depends on the implementation.
	 * There is no warranty that the replied figure is at 
	 * a given position in the collection replied by {@link #getSelectables()}.
	 * 
	 * @return a figure, never null.
	 * @see #getSelectables()
	 */
	public Selectable getSelectable() {
		return this.figures.iterator().next();
	}

	/** Replies the pointer event which is the cause of 
	 * this event.
	 * 
	 * @return the pointer event or null if
	 * there is no pointer event causing this interaction event.
	 */
	public ActionPointerEvent getPointerEvent() {
		return this.pointerEvent;
	}

	/** Replies the key event which is the cause of 
	 * this event.
	 * 
	 * @return the key event or null if
	 * there is no key event causing this interaction event.
	 */
	public KeyEvent getKeyEvent() {
		return this.keyEvent;
	}
	
	/**
     * Consumes this event so that it will not be processed
     * in the default manner by the source which originated it.
     */
    public void consume() {
        this.consumed = true;
        if (this.pointerEvent!=null)
        	this.pointerEvent.consume();
        if (this.keyEvent!=null)
        	this.keyEvent.consume();
    }

    /**
     * Returns whether or not this event has been consumed.
     * @return true if the event has been marked as consumed;
     * otherwise false.
     */
    public boolean isConsumed() {
        return this.consumed;
    }
    
}