org.jorigin.state.HandleDisplay 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 be displayed.
 * @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 HandleDisplay {
	
	/**
	 * Get if the object is currently displaying.
	 * @return true if the object is currently displaying and false otherwise.
	 * @see #setStateDisplaying(boolean)
	 */
    public boolean isStateDisplaying();
    
    /**
     * Set if the object has to be displaying.
     * This method has to modify the display state only if its {@link #isStateDisplayable() displayability} is set to true.
     * @param displaying true if the object is currently displaying and false otherwise.
     * @see #isStateDisplaying()
     */
    public void setStateDisplaying(boolean displaying);
    
	/**
	 * Get if the object display state can be modified. 
	 * @return true if the object display state can be modified and false otherwise.
	 * @see #isStateDisplaying()
	 * @see #setStateDisplayable(boolean)
	 */
	public boolean isStateDisplayable();
	
	/**
	 * Set if the object display state can be modified. 
	 * @param displayable true if the object display state can be modified and false otherwise.
	 * @see #setStateDisplaying(boolean)
	 * @see #isStateDisplayable()
	 */
	public void setStateDisplayable(boolean displayable);
}