com.rapiddweller.common.ui.swing.AlignedPane Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rd-lib-common Show documentation
'rapiddweller Common' is an open source Java library forked from Databene Commons by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.
There is a newer version: 2.0.1-jdk-11
Show newest version
/*
 * Copyright (C) 2004-2015 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.rapiddweller.common.ui.swing;

import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextArea;
import javax.swing.SwingConstants;
import java.awt.Component;
import java.awt.FlowLayout;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;

/**
 * A panel that allows for easy component aligning by an underlying {@link GridBagLayout}.
 * Created: 20.03.2005 11:19:06
 *
 * @author Volker Bergmann
 * @since 0.5.13
 */
public class AlignedPane extends JPanel implements SwingConstants {

  private static final long serialVersionUID = -5911452561809191394L;

  private final int orientation;
  private GridBagConstraints gbc;
  private final int columns;

  /**
   * Create horizontal pane aligned pane.
   *
   * @return the aligned pane
   */
  public static AlignedPane createHorizontalPane() {
    return new AlignedPane(HORIZONTAL, 0);
  }

  /**
   * Create vertical pane aligned pane.
   *
   * @return the aligned pane
   */
  public static AlignedPane createVerticalPane() {
    return createVerticalPane(2);
  }

  /**
   * Create vertical pane aligned pane.
   *
   * @param columns the columns
   * @return the aligned pane
   */
  public static AlignedPane createVerticalPane(int columns) {
    return new AlignedPane(VERTICAL, columns);
  }

  /**
   * Instantiates a new Aligned pane.
   */
  protected AlignedPane() {
    this(VERTICAL, 2);
  }

  /**
   * Instantiates a new Aligned pane.
   *
   * @param orientation the orientation
   * @param columns     the columns
   */
  protected AlignedPane(int orientation, int columns) {
    this.columns = columns;
    this.orientation = orientation;
    if (orientation == VERTICAL) {
      setLayout(new GridBagLayout());
    } else if (orientation == HORIZONTAL) {
      setLayout(new FlowLayout());
    } else {
      throw new IllegalArgumentException();
    }
    removeAll();
  }

  // interface -------------------------------------------------------------------------------------------------------

  @Override
  public void removeAll() {
    super.removeAll();
    if (orientation == VERTICAL) {
      gbc = new GridBagConstraints(
          0, 0, 1, 1, 0, 0,
          GridBagConstraints.NORTHWEST, GridBagConstraints.BOTH,
          new Insets(2, 2, 2, 2), 2, 2);
    }
  }

  /**
   * Add row.
   *
   * @param title     the title
   * @param component the component
   */
  public void addRow(String title, Component component) {
    if (orientation == HORIZONTAL) {
      add(new JLabel(title));
      add(component);
    } else {
      endRow();
      addElement(title, component, columns - 1);
      endRow();
    }
  }

  /**
   * Add row.
   *
   * @param component the component
   */
  public void addRow(Component component) {
    if (orientation == HORIZONTAL) {
      add(component, gbc);
      gbc.gridx++;
    } else {
      endRow();
      gbc.weightx = 1;
      gbc.weighty = (component instanceof JTextArea ? 1 : 0);
      gbc.gridwidth = columns;
      add(component, gbc);
      newRow();
    }
  }

  /**
   * Add tall row.
   *
   * @param component the component
   */
  public void addTallRow(Component component) {
    if (orientation == HORIZONTAL) {
      add(component);
    } else {
      endRow();
      gbc.weightx = 1;
      gbc.weighty = 1;
      gbc.gridwidth = columns;
      add(component, gbc);
      newRow();
    }
  }

  /**
   * Add element.
   *
   * @param title     the title
   * @param component the component
   */
  public void addElement(String title, Component component) {
    addElement(title, component, 1);
  }

  /**
   * Add element.
   *
   * @param title     the title
   * @param component the component
   * @param gridwidth the gridwidth
   */
  public void addElement(String title, Component component, int gridwidth) {
    JLabel label = new JLabel(title);
    if (orientation == HORIZONTAL) {
      add(label);
      add(component);
    } else {
      if (gbc.gridx > 0) {
        label.setHorizontalAlignment(RIGHT);
      }
      addElement(label, 1);
      addElement(component, gridwidth);
    }
  }

  /**
   * Add label.
   *
   * @param labelText the label text
   */
  public void addLabel(String labelText) {
    addElement(new JLabel(labelText), 1);
  }

  /**
   * Add element.
   *
   * @param component the component
   */
  public void addElement(Component component) {
    addElement(component, 1);
  }

  /**
   * Add element.
   *
   * @param component the component
   * @param gridwidth the gridwidth
   */
  public void addElement(Component component, int gridwidth) {
    if (orientation == HORIZONTAL) {
      add(component);
    } else {
      gbc.weightx = (component instanceof JLabel ? 0 : 1);
      gbc.weighty = (component instanceof JTextArea ? 1 : 0);
      gbc.gridwidth = gridwidth;
      add(component, gbc);
      gbc.gridx += gridwidth;
    }
  }

  /**
   * End row.
   */
  public void endRow() {
    if (orientation == VERTICAL && gbc.gridx > 0) {
      newRow();
    }
  }

  private void newRow() {
    gbc.gridy++;
    gbc.gridx = 0;
  }

  /**
   * Add separator.
   */
  public void addSeparator() {
    addLabelRow(" ");
  }

  /**
   * Add label row.
   *
   * @param text the text
   */
  public void addLabelRow(String text) {
    addRow(new JLabel(text));
  }

}