bibliothek.gui.dock.title.DockTitle Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of docking-frames-core Show documentation
Show all versions of docking-frames-core Show documentation
A window docking framework for Swing
The newest version!
/*
* 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) 2007 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
* [email protected]
* CH - Switzerland
*/
package bibliothek.gui.dock.title;
import java.awt.Component;
import javax.swing.event.MouseInputListener;
import bibliothek.gui.DockController;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.DockElementRepresentative;
import bibliothek.gui.dock.action.DockAction;
import bibliothek.gui.dock.component.DockComponentRoot;
import bibliothek.gui.dock.util.PropertyKey;
import bibliothek.gui.dock.util.property.ConstantPropertyFactory;
/**
* A {@link Component} which is shown aside a {@link Dockable}. A DockTitle
* displays some information about its Dockable, for
* example a title-text.
* Every DockTitle is owned by exactly one Dockable. The owner cannot
* be changed.
* Every title is either in the state {@link #bind() bound} or {@link #unbind() unbound}.
* As long as a title is unbound, it has not to do anything. As soon as it is
* bound, it has to ensure that it shows the correct properties. A title
* can assume that it is only bound when its Dockable knows
* the {@link DockController}.
* @author Benjamin Sigg
*/
public interface DockTitle extends DockElementRepresentative, DockComponentRoot{
/** Key for a {@link OrientationToRotationStrategy}. The strategy can tell this title how to render its text given
* the orientation of this title. */
public static final PropertyKey ORIENTATION_STRATEGY =
new PropertyKey( "DockTitle.orientation", new ConstantPropertyFactory( OrientationToRotationStrategy.DEFAULT ), true );
/** How to layout a {@link DockTitle} */
public static enum Orientation{
/**
* The title is at the north side of some panel.
*/
NORTH_SIDED( true ),
/**
* The title is at the south side of some panel.
*/
SOUTH_SIDED( true ),
/**
* The title is at the east side of some panel.
*/
EAST_SIDED( false ),
/**
* The title is at the west side of some panel.
*/
WEST_SIDED( false ),
/**
* The title is somehow vertical oriented.
*/
FREE_VERTICAL( false ),
/**
* The title is somehow horizontal oriented.
*/
FREE_HORIZONTAL( true );
private boolean horizontal;
private Orientation( boolean horizontal ){
this.horizontal = horizontal;
}
/**
* Tells a DockTitle that its preferred height should be smaller
* than its preferred width
* @return true if the title lays horizontal
*/
public boolean isHorizontal() {
return horizontal;
}
/**
* Tells a DockTitle that its preferred width should be smaller
* than its preferred height
* @return true if the title lays vertical
*/
public boolean isVertical(){
return !isHorizontal();
}
};
/**
* Gets a {@link Component} which paints this {@link DockTitle}.
* This method must always return the same {@link Component}.
* @return always the same {@link Component}
*/
public Component getComponent();
/**
* Adds a listener to all {@link Component}s of this title
* which are visible and which may be "grabbed" by the mouse.
* @param listener the new listener
*/
public void addMouseInputListener( MouseInputListener listener );
/**
* Removes a listener.
* @param listener the listener to remove
*/
public void removeMouseInputListener( MouseInputListener listener );
/**
* Gets the owner of this title.
* @return the owner
*/
public Dockable getDockable();
/**
* Sets the orientation of this title. The layout of this title
* should be influenced by the orientation.
* @param orientation the orientation
*/
public void setOrientation( Orientation orientation );
/**
* Gets the orientation of this title.
* @return the orientation
* @see #setOrientation(bibliothek.gui.dock.title.DockTitle.Orientation)
*/
public Orientation getOrientation();
/**
* Called if a property changed that might be important for painting this
* title. The property can be anything, it does not necessarily have to be
* a property of this title nor of its owner. Modules using this title
* might send subclasses of {@link DockTitleEvent} to transmit more information
* to this title than {@link DockTitleEvent} would allow.
* @param event information about the current state
*/
public void changed( DockTitleEvent event );
/**
* Tells whether this title is selected (active) or not. The title
* knows its state through the event-object of the method
* {@link #changed(DockTitleEvent) changed}.
* @return the selection state
*/
public boolean isActive();
/**
* Called before this title is displayed. This method should connect the
* title with other objects such as its {@link #getDockable() owner}.
* If the title wants to show some {@link DockAction DockActions} (see the method
* {@link DockController#listOffers(Dockable)}), then this method
* should {@link DockAction#bind(Dockable) bind} them too.
* Clients should never call this method directly, they should call
* {@link Dockable#bind(DockTitle)}. The {@link DockController}
* will call the bind-method, as soon as the Dockable knows the controller.
*/
public void bind();
/**
* The reverse of {@link #bind()}. The title should remove any connections
* to other objects and {@link DockAction#unbind(Dockable) unbind} its
* {@link DockAction}s.
* Clients should never call this method directly, they should call
* {@link Dockable#unbind(DockTitle)}. The {@link DockController}
* will call the unbind-method before the {@link Dockable} looses the controller.
*/
public void unbind();
/**
* Gets information about how this title was created. This {@link DockTitleVersion} can be used
* to create a {@link DockTitleRequest} which should create the same title again. If this title
* was not created through the regular methods, then this method is allowed
* to return null. However, some features will only work correctly
* if this value is not null.
* @return the title-version, might be null
*/
public DockTitleVersion getOrigin();
}