/*
* 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
* benjamin_sigg@gmx.ch
* CH - Switzerland
*/
package bibliothek.gui.dock.facile.action;
import java.awt.Component;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.GridLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.JTextField;
import javax.swing.event.PopupMenuEvent;
import javax.swing.event.PopupMenuListener;
import bibliothek.gui.DockController;
import bibliothek.gui.Dockable;
import bibliothek.gui.dock.DefaultDockable;
import bibliothek.gui.dock.FlapDockStation;
import bibliothek.gui.dock.SplitDockStation;
import bibliothek.gui.dock.StackDockStation;
import bibliothek.gui.dock.action.DockAction;
import bibliothek.gui.dock.action.DockActionIcon;
import bibliothek.gui.dock.action.DockActionText;
import bibliothek.gui.dock.action.actions.SimpleButtonAction;
import bibliothek.gui.dock.util.DockUtilities;
import bibliothek.util.ClientOnly;
/**
* This {@link DockAction} can change the {@link Dockable#getTitleText() title-text}
* of a {@link Dockable}. When this action is triggered, a popupmenu will appear,
* where the user can enter the new title of the {@link Dockable}.<br>
* RenameActions can be easely created by a {@link RenameActionFactory}
* @author Benjamin Sigg
*/
@ClientOnly
public abstract class RenameAction extends SimpleButtonAction {
/** the key uses for the {@link bibliothek.gui.dock.util.IconManager} to get the {@link Icon} of this action */
public static final String KEY_ICON = "rename";
/** the controller in whose realm this action is used */
private DockController controller;
/** button that is pressed if the new name should be applied */
private JButton okButton = new JButton();
/** button to cancel the event */
private JButton cancelButton = new JButton();
/** the field containing the new title */
private JTextField titleField = new JTextField();
/** the menu on which the items will be shown */
private JPopupMenu menu = new JPopupMenu();
/** the dockable whose title is currently changed */
private Dockable current;
/** the icon of this action */
private DockActionIcon icon;
/** text of this action */
private DockActionText text;
/** automatic tooltip fo this action */
private DockActionText tooltip;
/** text on the ok button */
private DockActionText textOk;
/** text on the cancel button */
private DockActionText textCancel;
private int bound = 0;
/**
* Constructs a new action
* @param controller The controller to which a listener will be added to
* get the Icon for this action
*/
public RenameAction( DockController controller ){
this.controller = controller;
icon = new DockActionIcon( KEY_ICON, this ){
protected void changed( Icon oldValue, Icon newValue ){
setIcon( newValue );
}
};
text = new DockActionText( "rename", this ){
protected void changed( String oldValue, String newValue ){
setText( newValue );
}
};
tooltip = new DockActionText( "rename.tooltip", this ){
protected void changed( String oldValue, String newValue ){
setTooltip( newValue );
}
};
menu.setLayout( new GridBagLayout() );
JPanel panel = new JPanel( new GridLayout( 1, 2 ));
panel.add( okButton );
panel.add( cancelButton );
menu.add( titleField, new GridBagConstraints( 0, 0, 1, 1, 100.0, 1.0,
GridBagConstraints.CENTER, GridBagConstraints.BOTH,
new Insets( 1, 1, 1, 1 ), 0, 0 ));
menu.add( panel, new GridBagConstraints( 1, 0, 1, 1, 1.0, 1.0,
GridBagConstraints.CENTER, GridBagConstraints.VERTICAL,
new Insets( 1, 1, 1, 1 ), 0, 0 ));
titleField.setColumns( 10 );
textOk = new DockActionText( "rename.ok", this ){
protected void changed( String oldValue, String newValue ){
okButton.setText( newValue );
}
};
textCancel = new DockActionText( "rename.cancel", this ){
protected void changed( String oldValue, String newValue ){
cancelButton.setText( newValue );
}
};
menu.addPopupMenuListener( new PopupMenuListener(){
public void popupMenuCanceled( PopupMenuEvent e ) {
current = null;
}
public void popupMenuWillBecomeInvisible( PopupMenuEvent e ) {
// do nothing
}
public void popupMenuWillBecomeVisible( PopupMenuEvent e ) {
// do nothing
}
});
okButton.addActionListener( new ActionListener(){
public void actionPerformed( ActionEvent e ){
rename();
}
});
cancelButton.addActionListener( new ActionListener(){
public void actionPerformed( ActionEvent e ){
menu.setVisible( false );
}
});
titleField.addActionListener( new ActionListener(){
public void actionPerformed( ActionEvent e ){
rename();
}
});
}
@Override
public void action( Dockable dockable ) {
titleField.setText( "" );
menu.setSize( menu.getPreferredSize() );
titleField.setText( dockable.getTitleText() );
Component component = DockUtilities.getShowingComponent( dockable );
if( component != null ){
current = dockable;
menu.show( component, 0, 0 );
titleField.requestFocus();
}
}
/**
* Changes the name of the current Dockable to the text of
* the {@link #titleField}.
*/
private void rename(){
rename( current, titleField.getText() );
menu.setVisible( false );
}
@Override
protected void bound( Dockable dockable ){
super.bound( dockable );
if( bound == 0 ){
icon.setController( controller );
text.setController( controller );
tooltip.setController( controller );
textOk.setController( controller );
textCancel.setController( controller );
}
bound++;
}
@Override
protected void unbound( Dockable dockable ){
super.unbound( dockable );
bound--;
if( bound == 0 ){
icon.setController( null );
text.setController( null );
tooltip.setController( null );
textOk.setController( null );
textCancel.setController( null );
}
}
/**
* Invoked when the action was triggered, and the user tipped in
* the new title for <code>dockable</code>.
* @param dockable The {@link Dockable} whose title should be changed
* @param text The new title
*/
protected abstract void rename( Dockable dockable, String text );
/**
* An implementation of {@link RenameAction} that can handle
* {@link StackDockStation StackDockStations}.
* @author Benjamin Sigg
*/
@ClientOnly
public static class RenameStackDockStation extends RenameAction{
/**
* Creates a new action
* @param controller the controller to which a listener will be added
*/
public RenameStackDockStation( DockController controller ) {
super( controller );
}
@Override
protected void rename( Dockable dock, String text ){
((StackDockStation)dock).setTitleText( text );
}
}
/**
* An implementation of {@link RenameAction} that can handle
* {@link SplitDockStation SplitDockStations}.
* @author Benjamin Sigg
*/
@ClientOnly
public static class RenameSplitDockStation extends RenameAction{
/**
* Creates a new action
* @param controller the controller to which a listener will be added
*/
public RenameSplitDockStation( DockController controller ) {
super( controller );
}
@Override
protected void rename( Dockable dock, String text ){
((SplitDockStation)dock).setTitleText( text );
}
}
/**
* An implementation of {@link RenameAction} that can handle
* {@link FlapDockStation FlapDockStations}.
* @author Benjamin Sigg
*/
@ClientOnly
public static class RenameFlapDockStation extends RenameAction{
/**
* Creates a new action
* @param controller the controller to which a listener will be added
*/
public RenameFlapDockStation( DockController controller ) {
super( controller );
}
@Override
protected void rename( Dockable dock, String text ){
((FlapDockStation)dock).setTitleText( text );
}
}
/**
* An implementation of {@link RenameAction} that can handle
* {@link DefaultDockable DefaultDockables}.
* @author Benjamin Sigg
*/
@ClientOnly
public static class RenameDefaultDockable extends RenameAction{
/**
* Creates a new action
* @param controller the controller to which a listener will be added
*/
public RenameDefaultDockable( DockController controller ) {
super( controller );
}
@Override
protected void rename( Dockable dock, String text ){
((DefaultDockable)dock).setTitleText( text );
}
}
}