/*
* Bibliothek - DockingFrames
* Library built on Java/Swing, allows the user to "drag and drop"
* panels containing any Swing-Component the developer likes to add.
*
* Copyright (C) 2009 Benjamin Sigg
*
* 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 2.1 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Benjamin Sigg
* benjamin_sigg@gmx.ch
* CH - Switzerland
*/
package bibliothek.gui.dock.facile.mode.status;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.common.mode.ExtendedMode;
import bibliothek.gui.dock.facile.mode.LocationModeManager;
/**
* Generic algorithm telling for {@link Dockable}s whether some {@link ExtendedMode} is
* available or not.
* @author Benjamin Sigg
*/
public interface ExtendedModeEnablement {
/**
* A measurement of how available a certain mode is. Is several {@link Availability}s are present,
* the first one of this list wins:
* <ol>
* <li> {@link Availability#STRONG_FORBIDDEN} </li>
* <li> {@link Availability#STRONG_AVAILABLE} </li>
* <li> {@link Availability#WEAK_FORBIDDEN} </li>
* <li> {@link Availability#WEAK_AVAILABLE} </li>
* <li> {@link Availability#UNCERTAIN} </li>
* </ol>
* @author Benjamin Sigg
*/
public static enum Availability{
/** the mode is most certainly available */
STRONG_AVAILABLE( true ),
/** the mode is probably available */
WEAK_AVAILABLE( true ),
/** the strategy cannot decide, some other code will make the decision */
UNCERTAIN( true ),
/** the mode is probably not available */
WEAK_FORBIDDEN( false ),
/** the mode is not available */
STRONG_FORBIDDEN( false );
private boolean available;
private Availability( boolean available ){
this.available = available;
}
/**
* Tells whether this {@link Availability} means "available" or "forbidden".
* @return <code>true</code> if <code>this</code> means "available".
*/
public boolean isAvailable(){
return available;
}
/**
* Gets the strongest {@link Availability} of <code>this</code> and <code>other</code>.
* @param other some other {@link Availability}
* @return the stronger of <code>this</code> and <code>other</code>
*/
public Availability strongest( Availability other ){
if( this == STRONG_FORBIDDEN || other == STRONG_FORBIDDEN ){
return STRONG_FORBIDDEN;
}
if( this == STRONG_AVAILABLE || other == STRONG_AVAILABLE ){
return STRONG_AVAILABLE;
}
if( this == WEAK_FORBIDDEN || other == WEAK_FORBIDDEN ){
return WEAK_FORBIDDEN;
}
if( this == WEAK_AVAILABLE || other == WEAK_AVAILABLE ){
return WEAK_AVAILABLE;
}
return UNCERTAIN;
}
}
/**
* A measurement of how hidden a certain mode is. Is several {@link Hidden}s are present,
* the first one of this list wins:
* <ol>
* <li> {@link Hidden#STRONG_HIDDEN} </li>
* <li> {@link Hidden#STRONG_VISIBLE} </li>
* <li> {@link Hidden#WEAK_HIDDEN} </li>
* <li> {@link Hidden#WEAK_VISIBLE} </li>
* <li> {@link Hidden#UNCERTAIN} </li>
* </ol>
* @author Benjamin Sigg
*/
public static enum Hidden{
/** the mode is most certainly hidden */
STRONG_HIDDEN( true ),
/** the mode is probably hidden */
WEAK_HIDDEN( true ),
/** the strategy cannot decide, some other code will make the decision */
UNCERTAIN( true ),
/** the mode is probably visible */
WEAK_VISIBLE( false ),
/** the mode is visible */
STRONG_VISIBLE( false );
private boolean hidden;
private Hidden( boolean available ){
this.hidden = available;
}
/**
* Tells whether this {@link Hidden} means "hidden" or "visible".
* @return <code>true</code> if <code>this</code> means "hidden".
*/
public boolean isHidden(){
return hidden;
}
/**
* Gets the strongest {@link Hidden} of <code>this</code> and <code>other</code>.
* @param other some other {@link Hidden}
* @return the stronger of <code>this</code> and <code>other</code>
*/
public Hidden strongest( Hidden other ){
if( this == STRONG_HIDDEN || other == STRONG_HIDDEN ){
return STRONG_HIDDEN;
}
if( this == STRONG_VISIBLE || other == STRONG_VISIBLE ){
return STRONG_VISIBLE;
}
if( this == WEAK_HIDDEN || other == WEAK_HIDDEN ){
return WEAK_HIDDEN;
}
if( this == WEAK_VISIBLE || other == WEAK_VISIBLE ){
return WEAK_VISIBLE;
}
return UNCERTAIN;
}
}
/**
* Tells whether <code>mode</code> is available for <code>dockable</code>.<br>
* <b>Note:</b> for {@link ExtendedMode#NORMALIZED} the result should always be <code>true</code>.
* @param dockable some element, not <code>null</code>
* @param mode some mode, not <code>null</code>
* @return whether the mode is available, most strategies should return {@link Availability#WEAK_AVAILABLE} if <code>mode</code> equals {@link ExtendedMode#NORMALIZED}.
* Must never be <code>null</code>, but a result of {@link Availability#UNCERTAIN} indicates that this enablement does not know
*/
public Availability isAvailable( Dockable dockable, ExtendedMode mode );
/**
* Tells whether <code>mode</code> is hidden from the user for <code>dockable</code>. If a mode
* is hidden it can still be available, the user will just not be informed (e.g. there is no button
* that will move the dockable).
* @param dockable some element, not <code>null</code>
* @param mode some mode, not <code>null</code>
* @return whether <code>mode</code> is hidden from the user when looking at <code>dockable</code>
*/
public Hidden isHidden( Dockable dockable, ExtendedMode mode );
/**
* Adds a listener to this enablement, the listener has be informed if the availability state of
* a mode in respect to a dockable has changed. Only {@link Dockable}s that are registered
* at the {@link LocationModeManager} have to be observed.
* @param listener the new listener
*/
public void addListener( ExtendedModeEnablementListener listener );
/**
* Removes a listener from this enablement.
* @param listener the listener to remove
*/
public void removeListener( ExtendedModeEnablementListener listener );
/**
* Informs this enablement that it is no longer of any use. The enablement
* should remove any listeners it added to any other object.
*/
public void destroy();
}