org.metawidget.swing.layout.MigLayout Maven / Gradle / Ivy
// Metawidget
//
// For historical reasons, this file is licensed under the LGPL
// (http://www.gnu.org/licenses/lgpl-2.1.html).
//
// Most other files in Metawidget are licensed under both the
// LGPL/EPL and a commercial license. See http://metawidget.org
// for details.
package org.metawidget.swing.layout;
import static org.metawidget.inspector.InspectionResultConstants.*;
import java.awt.Component;
import java.util.Map;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JScrollPane;
import javax.swing.JTextField;
import net.miginfocom.layout.CC;
import net.miginfocom.layout.LC;
import org.metawidget.layout.iface.AdvancedLayout;
import org.metawidget.swing.Facet;
import org.metawidget.swing.Stub;
import org.metawidget.swing.SwingMetawidget;
import org.metawidget.util.WidgetBuilderUtils;
import org.metawidget.util.simple.SimpleLayoutUtils;
import org.metawidget.util.simple.SimpleLayoutUtils.StrippedMnemonicAndFirstIndex;
import org.metawidget.util.simple.StringUtils;
/**
* Layout to arrange widgets using net.miginfocom.swing.MigLayout.
*
* Widgets are arranged in a table, with one column for labels and another for the widget.
*
* @author Stefan Ackerman
*/
public class MigLayout
implements AdvancedLayout {
//
// Private statics
//
private static final String LABEL_NAME_SUFFIX = "_label";
//
// Private members
//
private final int mNumberOfColumns;
private final boolean mSupportMnemonics;
private final boolean mDebugMode;
//
// Constructor
//
public MigLayout() {
this( new MigLayoutConfig() );
}
public MigLayout( MigLayoutConfig config ) {
mNumberOfColumns = config.getNumberOfColumns();
mSupportMnemonics = config.isSupportMnemonics();
mDebugMode = config.isDebugMode();
}
//
// Public methods
//
public void onStartBuild( SwingMetawidget metawidget ) {
// Do nothing
}
public void startContainerLayout( JComponent container, SwingMetawidget metawidget ) {
container.putClientProperty( MigLayout.class, null );
State state = getState( container );
// The entire layout should fill both horizontally and vertically,
// with no insets. This allows us to be properly nested, as well as
// embedded within existing UIs, without alignment problems
LC layoutConstraints = new LC().insets( "0" );
// Debug Info (draws the red and blue lines)
if ( mDebugMode ) {
layoutConstraints.debug( 500 );
}
// Create the Layout
//
// Note: we don't use column/row constraints, because we don't know
// what the components will be in advance. Rather, we use 'cell' and 'push'
java.awt.LayoutManager layoutManager = new net.miginfocom.swing.MigLayout( layoutConstraints );
container.setLayout( layoutManager );
// Calculate default label inset
//
// We top align all our labels, not just those belonging to 'tall' components,
// so that tall components, regular components and nested Metawidget components all line up.
// However, we still want the JLabels to be middle aligned for one-line components (such as
// JTextFields), so we top inset them a bit
JTextField dummyTextField = new JTextField();
dummyTextField.setLayout( layoutManager );
double dummyTextFieldHeight = dummyTextField.getPreferredSize().getHeight();
JLabel dummyLabel = new JLabel( "X" );
dummyLabel.setLayout( layoutManager );
double dummyLabelHeight = dummyLabel.getPreferredSize().getHeight();
state.defaultLabelVerticalPadding = (int) Math.max( 0, Math.floor( ( dummyTextFieldHeight - dummyLabelHeight ) / 2 ) );
}
public void layoutWidget( JComponent component, String elementName, Map attributes, JComponent container, SwingMetawidget metawidget ) {
// Do not render empty stubs
if ( component instanceof Stub && ( (Stub) component ).getComponentCount() == 0 ) {
// No need to 'CC.setHideMode', because never added to container
return;
}
// Special support for large components
State state = getState( container );
boolean spanAllColumns = component instanceof JScrollPane || component instanceof SwingMetawidget || SimpleLayoutUtils.isSpanAllColumns( attributes );
if ( spanAllColumns && state.currentColumn > 0 ) {
state.currentColumn = 0;
state.currentRow++;
}
// Layout a label...
String labelText = null;
if ( attributes != null ) {
labelText = metawidget.getLabelString( attributes );
}
layoutBeforeChild( component, labelText, elementName, attributes, container, metawidget );
// ...and layout the component
CC componentConstraints = new CC();
if ( labelText != null ) {
componentConstraints.cell( ( state.currentColumn * 2 ) + 1, state.currentRow );
} else {
componentConstraints.cell( state.currentColumn * 2, state.currentRow );
componentConstraints.spanX( 2 );
}
componentConstraints.pushX( 1f ).growX();
if ( spanAllColumns ) {
componentConstraints.spanX();
state.currentColumn = mNumberOfColumns;
}
componentConstraints.alignY( "top" );
// Assume large components should grow vertically
if ( willFillVertically( component, attributes ) ) {
componentConstraints.pushY( 1f ).growY();
}
// Add it
container.add( component, componentConstraints );
state.currentColumn++;
if ( state.currentColumn >= mNumberOfColumns ) {
state.currentColumn = 0;
state.currentRow++;
}
}
public void endContainerLayout( JComponent container, SwingMetawidget metawidget ) {
// Do nothing
}
public void onEndBuild( SwingMetawidget metawidget ) {
// Buttons
Facet buttonsFacet = metawidget.getFacet( "buttons" );
if ( buttonsFacet != null ) {
State state = getState( metawidget );
if ( state.currentColumn > 0 ) {
state.currentColumn = 0;
state.currentRow++;
}
metawidget.add( buttonsFacet, new CC().cell( 0, state.currentRow ).spanX().growX() );
}
}
//
// Protected methods
//
protected void layoutBeforeChild( Component component, String labelText, String elementName, Map attributes, JComponent container, SwingMetawidget metawidget ) {
State state = getState( container );
// Add label
if ( SimpleLayoutUtils.needsLabel( labelText, elementName ) ) {
JLabel label = new JLabel();
label.setName( attributes.get( NAME ) + LABEL_NAME_SUFFIX );
// Required
StrippedMnemonicAndFirstIndex stripMnemonic = SimpleLayoutUtils.stripMnemonic( labelText );
String labelTextToUse = stripMnemonic.getStrippedMnemonic();
if ( TRUE.equals( attributes.get( REQUIRED ) ) && !WidgetBuilderUtils.isReadOnly( attributes ) && !metawidget.isReadOnly() ) {
label.setText( labelTextToUse + "*" + StringUtils.SEPARATOR_COLON );
} else {
label.setText( labelTextToUse + StringUtils.SEPARATOR_COLON );
}
// Mnemonic
label.setLabelFor( component );
int mnemonicIndex = stripMnemonic.getFirstIndex();
if ( mnemonicIndex != -1 && mSupportMnemonics ) {
label.setDisplayedMnemonic( labelTextToUse.charAt( mnemonicIndex ) );
label.setDisplayedMnemonicIndex( mnemonicIndex );
}
// ComponentConstraints
CC labelConstraints = new CC();
labelConstraints.cell( state.currentColumn * 2, state.currentRow );
labelConstraints.growX();
// Top align all labels, not just those belonging to 'tall' components,
// so that tall components, regular components and nested Metawidget
// components all line up
labelConstraints.alignY( "top" );
// Apply some vertical padding so the label lines up with the component nicely
labelConstraints.pad( state.defaultLabelVerticalPadding, 0, state.defaultLabelVerticalPadding, 0 );
// Add it
container.add( label, labelConstraints );
}
}
protected boolean willFillVertically( JComponent component, Map attributes ) {
if ( attributes != null && TRUE.equals( attributes.get( LARGE ) ) ) {
return true;
}
if ( component instanceof JScrollPane ) {
return true;
}
return false;
}
//
// Private methods
//
private State getState( JComponent container ) {
State state = (State) container.getClientProperty( MigLayout.class );
if ( state == null ) {
state = new State();
container.putClientProperty( MigLayout.class, state );
}
return state;
}
//
// Inner class
//
/**
* Simple, lightweight structure for saving state.
*/
/* package private */static class State {
/* package private */int currentColumn;
/* package private */int currentRow;
/* package private */int defaultLabelVerticalPadding;
}
}