org.jorigin.state.HandleSelection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jcommon Show documentation

A java common package that enable to deal with various functionalities

There is a newer version: 1.0.9

package org.jorigin.state;

import org.jorigin.Common;

/**
 * An interface that describe an object that can handle selection state.
 * @author Julien SEINTURIER - Université de Toulon / CNRS LIS umr 7020 - github.com/jorigin/jcommon ([email protected])
 * @version {@value Common#version} - b{@value Common#BUILD}
 * @since 1.0.11
 */
public interface HandleSelection {

	/**
	 * Get if the object is selected.
	 * @return true if the object is selected and false otherwise.
	 * @see #isStateSelectable()
	 * @see #setStateSelected(boolean)
	 */
	public boolean isStateSelected();
	
	/**
	 * Set if the object is selected. 
	 * This method has to modify the selection state only if its {@link #isStateSelectable() selectability} is set to true.
	 * @param selected true if the object can be selected and false otherwise.
	 * @see #setStateSelectable(boolean)
	 * @see #isStateSelected()
	 */
	public void setStateSelected(boolean selected);
	
	/**
	 * Get if the object can be selected. 
	 * @return true if the object selection state can be modified and false otherwise.
	 * @see #isStateSelected()
	 * @see #setStateSelectable(boolean)
	 */
	public boolean isStateSelectable();
	
	/**
	 * Set if the object can be selected. 
	 * @param selectable true if the object selection state can be modified and false otherwise.
	 * @see #setStateSelected(boolean)
	 * @see #isStateSelectable()
	 */
	public void setStateSelectable(boolean selectable);
}