org.refcodes.graphical.DraggableAccessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-graphical Show documentation
Artifact for graphical issues regarding RGB, pixel, fonts, and other stuff (utility).
There is a newer version: 3.3.9
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// =============================================================================
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// together with the GPL linking exception applied; as being applied by the GNU
// Classpath ("http://www.gnu.org/software/classpath/license.html")
// =============================================================================
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// =============================================================================
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.graphical;

/**
 * Provides an accessor for a draggable property.
 */
public interface DraggableAccessor {

	/**
	 * Retrieves the draggability from the draggable property.
	 * 
	 * @return The draggability stored by the draggable property.
	 */
	boolean isDraggable();

	/**
	 * Provides a mutator for a draggable property.
	 */
	public interface DraggableMutator {

		/**
		 * Sets the draggability for the draggable property.
		 * 
		 * @param isDraggable The draggability to be stored by the draggability
		 *        property.
		 */
		void setDraggable( boolean isDraggable );

		/**
		 * Same as setting {@link #setDraggable(boolean)} to true.
		 */
		void draggable();

		/**
		 * Same as setting {@link #setDraggable(boolean)} to false.
		 */
		void stationary();
	}

	/**
	 * Provides a builder method for a draggable property returning the builder
	 * for applying multiple build operations.
	 * 
	 * @param  The builder to return in order to be able to apply multiple
	 *        build operations.
	 */
	public interface DraggableBuilder> {

		/**
		 * Sets the draggability for the draggable property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withDraggable();

		/**
		 * Sets the draggability for the draggable property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withStationary();

		/**
		 * Sets the draggability for the draggable property.
		 * 
		 * @param isDraggable The draggability to be stored by the draggability
		 *        property.
		 * 
		 * @return The builder for applying multiple build operations.
		 */
		B withDraggable( boolean isDraggable );
	}

	/**
	 * Provides a draggable property.
	 */
	public interface DraggableProperty extends DraggableAccessor, DraggableMutator {}
}