Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.metsci.glimpse.docking.TileImpl Maven / Gradle / Ivy
/*
* Copyright (c) 2016, Metron, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Metron, Inc. nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL METRON, INC. BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.metsci.glimpse.docking;
import static com.metsci.glimpse.docking.DockingUtils.*;
import static java.awt.BasicStroke.*;
import static java.awt.BorderLayout.CENTER;
import static java.awt.BorderLayout.EAST;
import static java.awt.BorderLayout.NORTH;
import static java.lang.Math.*;
import static javax.swing.BorderFactory.*;
import static javax.swing.SwingConstants.*;
import java.awt.BasicStroke;
import java.awt.BorderLayout;
import java.awt.CardLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.GradientPaint;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GridLayout;
import java.awt.LayoutManager;
import java.awt.Rectangle;
import java.awt.Stroke;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import javax.swing.JLabel;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.JToggleButton;
import javax.swing.JToolBar;
import com.metsci.glimpse.docking.DockingThemes.DockingTheme;
public class TileImpl extends Tile
{
public static interface TabComponentFactory
{
Component createComponent( Tile tile, View view );
}
protected class CustomTab extends JPanel
{
protected final int lineThickness = theme.lineThickness;
protected final int cornerRadius = theme.cornerRadius;
protected final int labelPadding = theme.labelPadding;
protected final Color lineColor = theme.lineColor;
protected final Color highlightColor = theme.highlightColor;
protected final Color selectedTextColor = theme.selectedTextColor;
protected final Color unselectedTextColor = theme.unselectedTextColor;
protected final View view;
protected boolean selected;
protected final JLabel label;
public CustomTab( View view )
{
setLayout( new BorderLayout( ) );
setOpaque( false );
setBorder( null );
setToolTipText( view.tooltip );
this.view = view;
this.selected = false;
this.label = new JLabel( view.title, view.icon, LEFT );
label.setForeground( unselectedTextColor );
// Add extra space on top and right, because text is right up against the edge
label.setBorder( createEmptyBorder( 2, lineThickness + labelPadding, 0, labelPadding + 2 ) );
add( label, CENTER );
Component cornerComponent = tabCornerComponentFactory.createComponent( TileImpl.this, view );
if ( cornerComponent != null )
{
add( cornerComponent, EAST );
}
}
public void setSelected( boolean selected )
{
if ( selected != this.selected )
{
this.selected = selected;
label.setForeground( selected ? selectedTextColor : unselectedTextColor );
}
}
@Override
public Dimension getPreferredSize( )
{
Dimension d = super.getPreferredSize( );
boolean rightmost = ( views.indexOf( view ) == rightmostViewNum( ) );
if ( rightmost ) d.width += lineThickness;
return d;
}
@Override
public Dimension getMinimumSize( )
{
Dimension d = super.getMinimumSize( );
boolean rightmost = ( views.indexOf( view ) == rightmostViewNum( ) );
if ( rightmost ) d.width += lineThickness;
return d;
}
@Override
protected void paintComponent( Graphics g0 )
{
Graphics2D g = ( Graphics2D ) g0;
int viewNum = views.indexOf( view );
int selectedViewNum = views.indexOf( selectedView );
int leftmostViewNum = leftmostViewNum( );
int rightmostViewNum = rightmostViewNum( );
boolean selected = ( viewNum == selectedViewNum );
boolean leftmost = ( viewNum == leftmostViewNum );
boolean rightmost = ( viewNum == rightmostViewNum );
int wBox = ( rightmost ? getWidth( ) : getWidth( ) + lineThickness );
int hBox = getHeight( );
// Fill
if ( selected )
{
Color bottomColor = new Color( highlightColor.getRed( ), highlightColor.getGreen( ), highlightColor.getBlue( ), 0 );
Color topColor = ( viewNum == selectedViewNum ? highlightColor : bottomColor );
g.setPaint( new GradientPaint( 0, 0, topColor, 0, getHeight( ) - 1, bottomColor ) );
g.fillRoundRect( lineThickness / 2, lineThickness / 2, wBox - lineThickness, hBox + cornerRadius, cornerRadius, cornerRadius );
}
// Edge lines
g.setPaint( lineColor );
g.setStroke( new BasicStroke( lineThickness ) );
// Top edge
if ( leftmost )
{
g.drawLine( cornerRadius, lineThickness / 2, wBox - 1, lineThickness / 2 );
}
else
{
g.drawLine( 0, lineThickness / 2, wBox - 1, lineThickness / 2 );
}
// Side edges
if ( selected )
{
g.drawRoundRect( lineThickness / 2, lineThickness / 2, wBox - lineThickness, hBox + cornerRadius, cornerRadius, cornerRadius );
}
else
{
// Left edge
if ( leftmost )
{
g.drawRoundRect( lineThickness / 2, lineThickness / 2, wBox + cornerRadius, hBox + cornerRadius, cornerRadius, cornerRadius );
}
else if ( viewNum == selectedViewNum + 1 )
{
g.drawRoundRect( lineThickness / 2 - ( wBox - lineThickness ), lineThickness / 2, wBox - lineThickness, hBox + cornerRadius, cornerRadius, cornerRadius );
}
else
{
g.drawLine( lineThickness / 2, 0, lineThickness / 2, hBox - 1 );
}
// Right edge
if ( rightmost )
{
g.drawLine( wBox - 1 - lineThickness / 2, 0, wBox - 1 - lineThickness / 2, hBox - 1 );
}
}
}
}
protected final DockingTheme theme;
protected final TabComponentFactory tabCornerComponentFactory;
protected final JPanel topBar;
protected final JToolBar tabBar;
protected final JToolBar overflowBar;
protected final JToggleButton overflowPopupButton;
protected final JPopupMenu overflowPopup;
protected final JToolBar cornerBar;
protected final JPanel viewBarHolder;
protected final CardLayout cardLayout;
protected final JPanel cardPanel;
protected final List dockingMouseAdapters;
protected final Map viewMap;
protected final List views;
protected View selectedView;
protected final Set listeners;
public TileImpl( DockingTheme theme, TabComponentFactory tabCornerComponentFactory, Component[] tileCornerComponents )
{
this.theme = theme;
final int lineThickness = theme.lineThickness;
final int cornerRadius = theme.cornerRadius;
final int cardPadding = theme.cardPadding;
final Color lineColor = theme.lineColor;
this.tabCornerComponentFactory = tabCornerComponentFactory;
this.tabBar = newToolbar( false );
tabBar.setBorder( null );
this.overflowBar = newToolbar( true );
this.overflowPopupButton = new JToggleButton( "\u00BB" );
this.overflowPopup = newButtonPopup( overflowPopupButton );
this.overflowBar.add( overflowPopupButton );
this.cornerBar = newToolbar( true );
for ( Component c : tileCornerComponents )
{
cornerBar.add( c );
}
this.viewBarHolder = new JPanel( new GridLayout( 1, 1 ) );
this.cardLayout = new CardLayout( );
this.cardPanel = new JPanel( cardLayout );
cardPanel.setBorder( createCompoundBorder( createMatteBorder( 0, lineThickness, lineThickness, lineThickness, lineColor ), createEmptyBorder( cardPadding, cardPadding, cardPadding, cardPadding ) ) );
this.dockingMouseAdapters = new ArrayList<>( );
this.viewMap = new HashMap<>( );
this.views = new ArrayList<>( );
this.selectedView = null;
this.topBar = new JPanel( )
{
protected void paintComponent( Graphics g0 )
{
Graphics2D g = ( Graphics2D ) g0;
super.paintComponent( g );
// Certain L&Fs get messed up if we don't reset the stroke back how we found it
Stroke origStroke = g.getStroke( );
g.setColor( lineColor );
g.setStroke( new BasicStroke( lineThickness, CAP_BUTT, JOIN_MITER ) );
g.drawRoundRect( lineThickness / 2, lineThickness / 2, getWidth( ) - lineThickness, getHeight( ) + cornerRadius, cornerRadius, cornerRadius );
for ( View view : views )
{
if ( view != selectedView )
{
CustomTab tab = viewMap.get( view.viewId ).tab;
// CAP_BUTT behaves differently when line-width is 1
int wExtra = ( lineThickness > 1 ? lineThickness : 0 );
g.drawLine( tab.getX( ), getHeight( ) - 1 - lineThickness / 2, tab.getX( ) + tab.getWidth( ) + wExtra, getHeight( ) - 1 - lineThickness / 2 );
}
}
g.drawLine( tabBar.getWidth( ) - lineThickness, getHeight( ) - 1 - lineThickness / 2, getWidth( ) - 1, getHeight( ) - 1 - lineThickness / 2 );
g.setStroke( origStroke );
}
};
topBar.setOpaque( true );
topBar.add( tabBar );
topBar.add( overflowBar );
topBar.add( viewBarHolder );
topBar.add( cornerBar );
topBar.setLayout( new LayoutManager( )
{
public void layoutContainer( Container parent )
{
int wTotal = topBar.getWidth( ) - cornerRadius;
int wCornerBar = cornerBar.getMinimumSize( ).width;
int wOverflowBar = overflowBar.getMinimumSize( ).width;
for ( View view : views )
{
ViewEntry viewEntry = viewMap.get( view.viewId );
viewEntry.overflowMenuItem.setVisible( false );
viewEntry.tab.setVisible( true );
}
overflowBar.setVisible( false );
boolean needsOverflow = false;
while ( true )
{
tabBar.doLayout( );
int wTabBar = tabBar.getMinimumSize( ).width;
int wAvail = wTotal - wCornerBar - ( needsOverflow ? wOverflowBar : 0 );
if ( wTabBar <= wAvail ) break;
int numVisible = 0;
ViewEntry firstVisible = null;
ViewEntry lastVisible = null;
for ( View view : views )
{
ViewEntry viewEntry = viewMap.get( view.viewId );
if ( viewEntry.tab.isVisible( ) )
{
numVisible++;
lastVisible = viewEntry;
if ( firstVisible == null ) firstVisible = viewEntry;
}
}
if ( numVisible <= 1 ) break;
ViewEntry victim = ( lastVisible.view == selectedView ? firstVisible : lastVisible );
victim.overflowMenuItem.setVisible( true );
victim.tab.setVisible( false );
needsOverflow = true;
}
int y = 0;
int hTotal = topBar.getHeight( ) - lineThickness;
int xTabBar = 0;
int wTabBar = tabBar.getMinimumSize( ).width;
tabBar.setBounds( xTabBar, y, wTabBar, hTotal );
if ( needsOverflow )
{
int xOverflowBar = tabBar.getX( ) + tabBar.getWidth( );
overflowBar.setBounds( xOverflowBar, y + lineThickness, wOverflowBar, hTotal - lineThickness );
overflowBar.setVisible( true );
}
int xCornerBar = wTotal - wCornerBar;
cornerBar.setBounds( xCornerBar, y + lineThickness, wCornerBar, hTotal - lineThickness );
viewBarHolder.removeAll( );
if ( selectedView == null || selectedView.toolbar == null || !viewMap.containsKey( selectedView.viewId ) )
{
viewBarHolder.setVisible( false );
}
else
{
JPanel viewCard = viewMap.get( selectedView.viewId ).card;
JToolBar viewBar = selectedView.toolbar;
int xViewBar = xTabBar + wTabBar + ( needsOverflow ? wOverflowBar : 0 );
int wViewBar = xCornerBar - xViewBar;
if ( viewBar.getMinimumSize( ).width <= wViewBar )
{
viewCard.remove( viewBar );
viewBarHolder.add( viewBar );
viewBarHolder.setBounds( xViewBar, y + lineThickness, wViewBar, hTotal - lineThickness );
viewBarHolder.setVisible( true );
}
else
{
viewBarHolder.setVisible( false );
viewCard.add( viewBar, NORTH );
}
}
}
public void addLayoutComponent( String name, Component comp )
{
}
public void removeLayoutComponent( Component comp )
{
}
public Dimension preferredLayoutSize( Container parent )
{
int wTile = getWidth( );
int hBars = lineThickness + max( tabBar.getPreferredSize( ).height, max( overflowBar.getPreferredSize( ).height + lineThickness, cornerBar.getPreferredSize( ).height + lineThickness ) );
return new Dimension( wTile, hBars );
}
public Dimension minimumLayoutSize( Container parent )
{
int wTab = 0;
for ( View view : views )
{
ViewEntry viewEntry = viewMap.get( view.viewId );
wTab = max( wTab, viewEntry.tab.getMinimumSize( ).width );
}
int wBars = wTab + overflowBar.getMinimumSize( ).width + cornerBar.getMinimumSize( ).width + cornerRadius;
int hBars = lineThickness + max( tabBar.getMinimumSize( ).height, max( overflowBar.getMinimumSize( ).height + lineThickness, cornerBar.getMinimumSize( ).height + lineThickness ) );
return new Dimension( wBars, hBars );
}
} );
setLayout( new BorderLayout( ) );
add( topBar, NORTH );
add( cardPanel, CENTER );
this.listeners = new LinkedHashSet<>( );
}
@Override
public void addListener( TileListener listener )
{
listeners.add( listener );
}
@Override
public void removeListener( TileListener listener )
{
listeners.remove( listener );
}
@Override
public int numViews( )
{
return views.size( );
}
@Override
public View view( int viewNum )
{
return views.get( viewNum );
}
@Override
public View selectedView( )
{
return selectedView;
}
@Override
public void addView( final View view, int viewNum )
{
JPanel card = new JPanel( new BorderLayout( ) );
card.add( view.component, BorderLayout.CENTER );
cardPanel.add( card, view.viewId );
CustomTab tab = new CustomTab( view );
tab.addMouseListener( new MouseAdapter( )
{
public void mousePressed( MouseEvent ev )
{
selectViewById( view.viewId );
}
} );
for ( MouseAdapter mouseAdapter : dockingMouseAdapters )
{
addMouseAdapter( tab, mouseAdapter );
}
tabBar.add( tab, viewNum );
JMenuItem overflowMenuItem = new JMenuItem( view.title, view.icon );
overflowMenuItem.setToolTipText( view.tooltip );
overflowMenuItem.addActionListener( new ActionListener( )
{
public void actionPerformed( ActionEvent ev )
{
selectViewById( view.viewId );
}
} );
overflowPopup.add( overflowMenuItem );
viewMap.put( view.viewId, new ViewEntry( view, card, tab, overflowMenuItem ) );
views.add( viewNum, view );
for ( TileListener listener : listeners )
{
listener.addedView( view );
}
if ( selectedView == null )
{
selectView( view );
}
}
@Override
public void updateView( View view )
{
int index = views.indexOf( view );
ViewEntry entry = viewMap.get( view.viewId );
if ( entry == null || index < 0 )
{
throw new IllegalArgumentException( String.format( "View %s does not exist. addView( ) must be called prior to updateView( ).", view.viewId ) );
}
// only replace the component if it has changed (avoids flicker under some circumstances)
if ( view.component != entry.view.component )
{
entry.card.remove( entry.view.component );
entry.card.add( view.component, BorderLayout.CENTER );
}
entry.tab.label.setText( view.title );
entry.tab.label.setIcon( view.icon );
entry.tab.setToolTipText( view.tooltip );
entry.overflowMenuItem.setText( view.title );
entry.overflowMenuItem.setIcon( view.icon );
entry.overflowMenuItem.setToolTipText( view.tooltip );
views.set( index, view );
viewMap.put( view.viewId, new ViewEntry( view, entry.card, entry.tab, entry.overflowMenuItem ) );
// if the view being updated is the selectedView:
// 1) set selectedView to point to the new view
// 2) update the toolbar, which may have changed
if ( Objects.equals( selectedView, view ) )
{
selectedView = view;
topBar.doLayout( );
topBar.repaint( );
}
}
@Override
public void removeView( View view )
{
boolean removingSelectedView = ( view == selectedView );
if ( removingSelectedView )
{
selectView( null );
}
ViewEntry viewEntry = viewMap.remove( view.viewId );
overflowPopup.remove( viewEntry.overflowMenuItem );
tabBar.remove( viewEntry.tab );
cardPanel.remove( viewEntry.card );
views.remove( view );
for ( TileListener listener : listeners )
{
listener.removedView( view );
}
if ( removingSelectedView && !views.isEmpty( ) )
{
selectView( views.get( 0 ) );
}
validate( );
repaint( );
}
@Override
public boolean hasView( View view )
{
return ( view != null && viewMap.containsKey( view.viewId ) );
}
protected void selectViewById( String viewId )
{
selectView( viewMap.get( viewId ).view );
}
@Override
public void selectView( View view )
{
if ( view == selectedView ) return;
if ( selectedView != null && viewMap.containsKey( selectedView.viewId ) )
{
ViewEntry viewEntry = viewMap.get( selectedView.viewId );
viewEntry.tab.setSelected( false );
cardPanel.setVisible( false );
}
if ( view != null )
{
ViewEntry viewEntry = viewMap.get( view.viewId );
viewEntry.tab.setSelected( true );
cardLayout.show( cardPanel, view.viewId );
cardPanel.setVisible( true );
}
selectedView = view;
topBar.doLayout( );
topBar.repaint( );
for ( TileListener listener : listeners )
{
listener.selectedView( view );
}
}
@Override
public int viewNumForTabAt( int x, int y )
{
for ( int viewNum = 0; viewNum < numViews( ); viewNum++ )
{
Rectangle tabBounds = tabBounds( viewNum );
if ( tabBounds != null && tabBounds.contains( x, y ) )
{
return viewNum;
}
}
return -1;
}
@Override
public Rectangle viewTabBounds( int viewNum )
{
Rectangle bounds = tabBounds( viewNum );
bounds.height += theme.lineThickness;
if ( viewNum != rightmostViewNum( ) )
{
bounds.width += theme.lineThickness;
}
return bounds;
}
protected Rectangle tabBounds( int viewNum )
{
CustomTab tab = viewEntry( viewNum ).tab;
if ( !tab.isVisible( ) ) return null;
// Tab position relative to tile
int x = 0;
int y = 0;
for ( Component c = tab; c != this; c = c.getParent( ) )
{
x += c.getX( );
y += c.getY( );
}
return new Rectangle( x, y, tab.getWidth( ), tab.getHeight( ) );
}
protected int leftmostViewNum( )
{
for ( int i = 0; i < views.size( ); i++ )
{
if ( viewEntry( i ).tab.isVisible( ) )
{
return i;
}
}
return -1;
}
protected int rightmostViewNum( )
{
for ( int i = views.size( ) - 1; i >= 0; i-- )
{
if ( viewEntry( i ).tab.isVisible( ) )
{
return i;
}
}
return views.size( );
}
@Override
public void addDockingMouseAdapter( MouseAdapter mouseAdapter )
{
for ( View view : views )
{
CustomTab tab = viewMap.get( view.viewId ).tab;
addMouseAdapter( tab, mouseAdapter );
}
this.dockingMouseAdapters.add( mouseAdapter );
}
public static void addMouseAdapter( Component c, MouseAdapter mouseAdapter )
{
c.addMouseListener( mouseAdapter );
c.addMouseMotionListener( mouseAdapter );
c.addMouseWheelListener( mouseAdapter );
}
protected ViewEntry viewEntry( int viewNum )
{
return viewMap.get( views.get( viewNum ).viewId );
}
protected static class ViewEntry
{
public final View view;
public final JPanel card;
public final CustomTab tab;
public final JMenuItem overflowMenuItem;
public ViewEntry( View view, JPanel card, CustomTab tab, JMenuItem overflowMenuItem )
{
this.view = view;
this.card = card;
this.tab = tab;
this.overflowMenuItem = overflowMenuItem;
}
}
}
