bibliothek.gui.dock.toolbar.expand.ExpandableToolbarItem Maven / Gradle / Ivy
/*
* 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) 2012 Herve Guillaume, 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
*
* Herve Guillaume
* [email protected]
* FR - France
*
* Benjamin Sigg
* [email protected]
* CH - Switzerland
*/
package bibliothek.gui.dock.toolbar.expand;
import bibliothek.gui.Dockable;
/**
* An {@link ExpandableToolbarItem} is a part of a toolbar that can have
* different shapes.
*
* @author Benjamin Sigg
*/
public interface ExpandableToolbarItem extends Dockable{
/**
* Adds the observer listener to this item.
* @param listener the new listener, not null
*/
public void addExpandableListener( ExpandableToolbarItemListener listener );
/**
* Removes the observer listener from this item.
* @param listener the listener to remove
*/
public void removeExpandableListener( ExpandableToolbarItemListener listener );
/**
* Tells whether this {@link ExpandableToolbarItem} likes to be in state state.
* @param state a possible state
* @return whether this item likes to be in state
*/
public boolean isEnabled( ExpandedState state );
/**
* Changes the state of this item to state. Note that state
* can be any state, including those for which {@link #isEnabled(ExpandedState)} returned
* false.
* @param state the new state
*/
public void setExpandedState( ExpandedState state );
/**
* Gets the current state of this item.
* @return the current state
*/
public ExpandedState getExpandedState();
}