[jsword-svn] common/java/swing/org/crosswire/common/swing/desktop s
jswordcvs at crosswire.org
jswordcvs at crosswire.org
Sun May 8 18:28:44 MST 2005
Update of /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop
In directory www.crosswire.org:/tmp/cvs-serv5945/java/swing/org/crosswire/common/swing/desktop
Modified Files:
ViewManager.java LayoutType.java MDIViewLayout.java
TDIViewLayout.java ToolBar.java Viewable.java Msg.java
Added Files:
AbstractViewLayout.java
Removed Files:
ViewLayout.java
Log Message:
Moved unused code to limbo.
Upgraded support-tools: checkstyle, pmd and findbugs to most recent.
Addressed over 100 issues reported by findbugs and checkstyle.
Resulted in major refactoring of GBFFilter.
Net result is that code size is significantly smaller.
Index: Msg.java
===================================================================
RCS file: /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop/Msg.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** Msg.java 8 Sep 2004 19:53:37 -0000 1.1
--- Msg.java 9 May 2005 01:28:42 -0000 1.2
***************
*** 29,34 ****
public class Msg extends MsgBase
{
! // Strings for ViewLayout
! static final Msg UNTITLED = new Msg("ViewLayout.Untitled"); //$NON-NLS-1$
/**
--- 29,34 ----
public class Msg extends MsgBase
{
! // Strings for AbstractViewLayout
! static final Msg UNTITLED = new Msg("AbstractViewLayout.Untitled"); //$NON-NLS-1$
/**
Index: MDIViewLayout.java
===================================================================
RCS file: /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop/MDIViewLayout.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** MDIViewLayout.java 21 Sep 2004 17:45:47 -0000 1.2
--- MDIViewLayout.java 9 May 2005 01:28:42 -0000 1.3
***************
*** 41,45 ****
* @version $Id$
*/
! public class MDIViewLayout extends ViewLayout
{
/**
--- 41,45 ----
* @version $Id$
*/
! public class MDIViewLayout extends AbstractViewLayout
{
/**
***************
*** 55,59 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#addView(java.awt.Component)
*/
public void addView(Component view)
--- 55,59 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#addView(java.awt.Component)
*/
public void addView(Component view)
***************
*** 77,81 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#removeView(java.awt.Component)
*/
public void removeView(Component view)
--- 77,81 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#removeView(java.awt.Component)
*/
public void removeView(Component view)
***************
*** 107,111 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#forceRemoveView(java.awt.Component)
*/
protected void forceRemoveView(Component component)
--- 107,111 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#forceRemoveView(java.awt.Component)
*/
protected void forceRemoveView(Component component)
***************
*** 124,128 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#updateTitle(java.awt.Component)
*/
public void updateTitle(Component view)
--- 124,128 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#updateTitle(java.awt.Component)
*/
public void updateTitle(Component view)
***************
*** 136,140 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#getSelected()
*/
public Component getSelected()
--- 136,140 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#getSelected()
*/
public Component getSelected()
***************
*** 172,176 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#select(java.awt.Component)
*/
public void select(Component component)
--- 172,176 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#select(java.awt.Component)
*/
public void select(Component component)
Index: TDIViewLayout.java
===================================================================
RCS file: /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop/TDIViewLayout.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** TDIViewLayout.java 21 Sep 2004 17:45:47 -0000 1.2
--- TDIViewLayout.java 9 May 2005 01:28:42 -0000 1.3
***************
*** 35,39 ****
* @version $Id$
*/
! public class TDIViewLayout extends ViewLayout
{
/**
--- 35,39 ----
* @version $Id$
*/
! public class TDIViewLayout extends AbstractViewLayout
{
/**
***************
*** 48,52 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#addView(java.awt.Component)
*/
public void addView(Component component)
--- 48,52 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#addView(java.awt.Component)
*/
public void addView(Component component)
***************
*** 75,79 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#removeView(java.awt.Component)
*/
public void removeView(Component component)
--- 75,79 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#removeView(java.awt.Component)
*/
public void removeView(Component component)
***************
*** 107,111 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#forceRemoveView(java.awt.Component)
*/
protected void forceRemoveView(Component component)
--- 107,111 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#forceRemoveView(java.awt.Component)
*/
protected void forceRemoveView(Component component)
***************
*** 161,165 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.ViewLayout#select(java.awt.Component)
*/
public void select(Component component)
--- 161,165 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.AbstractViewLayout#select(java.awt.Component)
*/
public void select(Component component)
Index: LayoutType.java
===================================================================
RCS file: /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop/LayoutType.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** LayoutType.java 30 Jan 2005 18:26:05 -0000 1.3
--- LayoutType.java 9 May 2005 01:28:42 -0000 1.4
***************
*** 43,47 ****
* @see org.crosswire.common.swing.desktop.LayoutType#createLayout()
*/
! public ViewLayout createLayout()
{
return new TDIViewLayout();
--- 43,47 ----
* @see org.crosswire.common.swing.desktop.LayoutType#createLayout()
*/
! public AbstractViewLayout createLayout()
{
return new TDIViewLayout();
***************
*** 62,66 ****
* @see org.crosswire.common.swing.desktop.LayoutType#createLayout()
*/
! public ViewLayout createLayout()
{
return new MDIViewLayout();
--- 62,66 ----
* @see org.crosswire.common.swing.desktop.LayoutType#createLayout()
*/
! public AbstractViewLayout createLayout()
{
return new MDIViewLayout();
***************
*** 86,90 ****
* @return the layout
*/
! public ViewLayout getLayout()
{
// In order to get the proper LAF it needs to be created after the LAF is set
--- 86,90 ----
* @return the layout
*/
! public AbstractViewLayout getLayout()
{
// In order to get the proper LAF it needs to be created after the LAF is set
***************
*** 101,105 ****
* @return the created view layout
*/
! public abstract ViewLayout createLayout();
/**
--- 101,105 ----
* @return the created view layout
*/
! public abstract AbstractViewLayout createLayout();
/**
***************
*** 180,184 ****
* The actual layout
*/
! protected ViewLayout layout;
// Support for serialization
--- 180,184 ----
* The actual layout
*/
! protected AbstractViewLayout layout;
// Support for serialization
Index: Viewable.java
===================================================================
RCS file: /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop/Viewable.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Viewable.java 21 Sep 2004 17:45:47 -0000 1.2
--- Viewable.java 9 May 2005 01:28:42 -0000 1.3
***************
*** 59,63 ****
* @param other the other layout
*/
! public abstract void moveTo(ViewLayout other);
/**
--- 59,63 ----
* @param other the other layout
*/
! public abstract void moveTo(AbstractViewLayout other);
/**
Index: ToolBar.java
===================================================================
RCS file: /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop/ToolBar.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** ToolBar.java 19 Mar 2005 18:45:07 -0000 1.4
--- ToolBar.java 9 May 2005 01:28:42 -0000 1.5
***************
*** 213,217 ****
*/
private JFrame frame;
! private ActionFactory actions;
/**
--- 213,217 ----
*/
private JFrame frame;
! private transient ActionFactory actions;
/**
--- ViewLayout.java DELETED ---
--- NEW FILE: AbstractViewLayout.java ---
package org.crosswire.common.swing.desktop;
import java.awt.Component;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import javax.swing.JPanel;
import javax.swing.event.EventListenerList;
import org.crosswire.common.swing.desktop.event.ViewEvent;
import org.crosswire.common.swing.desktop.event.ViewEventListener;
/**
* Abstract manager of how we layout views.
*
* <p><table border='1' cellPadding='3' cellSpacing='0'>
* <tr><td bgColor='white' class='TableRowColor'><font size='-7'>
*
* Distribution Licence:<br />
* JSword is free software; you can redistribute it
* and/or modify it under the terms of the GNU General Public License,
* version 2 as published by the Free Software Foundation.<br />
* This program 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
* General Public License for more details.<br />
* The License is available on the internet
* <a href='http://www.gnu.org/copyleft/gpl.html'>here</a>, or by writing to:
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
* MA 02111-1307, USA<br />
* The copyright to this program is held by it's authors.
* </font></td></tr></table>
* @see gnu.gpl.Licence
* @author Joe Walker [joe at eireneh dot com]
* @author DM Smith [dmsmith555 at yahoo dot com]
* @version $Id: AbstractViewLayout.java,v 1.1 2005/05/09 01:28:42 dmsmith Exp $
*/
public abstract class AbstractViewLayout implements Viewable
{
/**
* This constructor is protected because it only needs to be seen by
* the sub classes
*/
protected AbstractViewLayout()
{
panel = new JPanel(new GridBagLayout());
views = new ArrayList();
listenerList = new EventListenerList();
gbc = new GridBagConstraints();
gbc.fill = GridBagConstraints.BOTH;
gbc.weightx = 1.0;
gbc.weighty = 1.0;
}
/**
* Add a view to the set.
*/
public void addView(Component component)
{
views.add(component);
}
/**
* Remove a view from the set.
*/
public void removeView(Component component)
{
views.remove(component);
fireViewRemoved(new ViewEvent(component));
}
/**
* Unconditionally remove a view from the set.
*/
protected void forceRemoveView(Component component)
{
views.remove(component);
}
/**
* Get a snapshot of the views as a collection.
* @return the views
*/
public Collection getViews()
{
return new ArrayList(views);
}
/**
* Get an iterator of a snapshot of views.
* @return an iterator over the views.
*/
public Iterator iterator()
{
return getViews().iterator();
}
/**
* Copies all the views from the one layout to the other
* @param other the other layout
*/
public void moveTo(AbstractViewLayout other)
{
// Make sure we are copying to something else
if (getClass() == other.getClass())
{
return;
}
// Go through the views removing them from the layout
// and adding them to the other
Iterator it = iterator();
while (it.hasNext())
{
Component view = (Component) it.next();
forceRemoveView(view);
other.addView(view);
}
}
/**
* Close all the views. Note the policy is enforced that one view is kept.
* This will keep the last one added.
*/
public void closeAll()
{
Iterator it = iterator();
while (it.hasNext())
{
Component view = (Component) it.next();
removeView(view);
}
}
/**
* Close all the views but the one provided.
* @param component the view that is to remain open.
*/
public void closeOthers(Component component)
{
Iterator it = iterator();
while (it.hasNext())
{
Component view = (Component) it.next();
if (view != component)
{
removeView(view);
}
}
}
/**
* Visit every view in the order that they were added.
* @param visitor The visitor for the view
*/
public void visit(ViewVisitor visitor)
{
Iterator it = iterator();
while (it.hasNext())
{
Component view = (Component) it.next();
visitor.visitView(view);
}
}
/**
* Update the title of the view. If the component does not
* implement Titleable, then a generated title will be used.
* @param component the component whose title is to be used
*/
public abstract void updateTitle(Component component);
/**
* Returns the top view. If no view is the top, it returns the
* first one added.
*/
public abstract Component getSelected();
/**
* Find the view and select it.
* @param component
*/
public abstract void select(Component component);
/**
* The number of views held by this layout.
* @return the number of views held by this layout
*/
public int getViewCount()
{
return views.size();
}
/**
* Get the view by position. Note that adding and removing views
* changes the indexes of the views. Do not use this for iteration
* as it is not thread safe.
* @param i the index of the view
* @return the requested view.
*/
public Component getView(int i)
{
return (Component) views.get(i);
}
/**
* Get the title from the component, truncating it if necessary.
* If the component does not implement Titleable of if the title is empty,
* then titles are generated.
* @param component from whom the title is gotten
* @return the title, possibly truncated or generated
*/
protected String getTitle(Component component)
{
if (component instanceof Titleable)
{
Titleable view = (Titleable) component;
String title = view.getTitle();
if (title != null && title.length() > 0)
{
if (title.length() <= MAX_TITLE_LEN)
{
return title;
}
return title.substring(0, MAX_TITLE_LEN - 3) + "..."; //$NON-NLS-1$
}
// should set the title also
return generateTitle();
}
return generateTitle();
}
/**
* Generates a generic title
* @return the generated title
*/
private String generateTitle()
{
return Msg.UNTITLED.toString(new Integer(base++));
}
/**
* All parts are put into a panel. This prevents the programmer from
* having to change containers.
* @return Returns the panel.
*/
protected JPanel getPanel()
{
return panel;
}
/**
* A constraint that allows the panel to be filled up,
* stretching horizonally and vertically.
* @return the constraint
*/
protected Object getConstraint()
{
return gbc;
}
/**
* Adds a view event listener for notification of any changes to the view.
*
* @param listener the listener
*/
public synchronized void addViewEventListener(ViewEventListener listener)
{
listenerList.add(ViewEventListener.class, listener);
}
/**
* Removes a view event listener.
*
* @param listener the listener
*/
public synchronized void removeViewEventListener(ViewEventListener listener)
{
listenerList.remove(ViewEventListener.class, listener);
}
/**
* Notify the listeners that the view has been removed.
*
* @param e the event
* @see EventListenerList
*/
public void fireViewRemoved(ViewEvent e)
{
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// Process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length - 2; i >= 0; i -= 2)
{
if (listeners[i] == ViewEventListener.class)
{
((ViewEventListener) listeners[i + 1]).viewRemoved(e);
}
}
}
/**
* The list of views.
*/
private List views;
/**
* The listeners for handling ViewEvent Listeners
*/
private EventListenerList listenerList = new EventListenerList();
/**
* The maximum length of a title before it is abbreviated
*/
private static final int MAX_TITLE_LEN = 30;
/**
* A shared counter for creating unknown titles.
*/
private static int base = 1;
/**
* The panel into which all components are placed.
*/
private JPanel panel;
/**
* A shared, reusable constraint that makes its contents
* grow to fill the area.
*/
private GridBagConstraints gbc;
}
Index: ViewManager.java
===================================================================
RCS file: /cvs/jsword/common/java/swing/org/crosswire/common/swing/desktop/ViewManager.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** ViewManager.java 21 Sep 2004 17:45:47 -0000 1.2
--- ViewManager.java 9 May 2005 01:28:42 -0000 1.3
***************
*** 151,157 ****
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.Viewable#moveTo(org.crosswire.common.swing.desktop.ViewLayout)
*/
! public void moveTo(ViewLayout other)
{
getViewLayout().moveTo(other);
--- 151,157 ----
/* (non-Javadoc)
! * @see org.crosswire.common.swing.desktop.Viewable#moveTo(org.crosswire.common.swing.desktop.AbstractViewLayout)
*/
! public void moveTo(AbstractViewLayout other)
{
getViewLayout().moveTo(other);
***************
*** 291,295 ****
* What is the current layout?
*/
! public final ViewLayout getViewLayout()
{
return getViewLayoutType().getLayout();
--- 291,295 ----
* What is the current layout?
*/
! public final AbstractViewLayout getViewLayout()
{
return getViewLayoutType().getLayout();
***************
*** 307,312 ****
}
! ViewLayout nextLayout = next.getLayout();
! ViewLayout currentLayout = getViewLayout();
currentLayout.moveTo(nextLayout);
--- 307,312 ----
}
! AbstractViewLayout nextLayout = next.getLayout();
! AbstractViewLayout currentLayout = getViewLayout();
currentLayout.moveTo(nextLayout);
More information about the jsword-svn
mailing list