03 December 2008

coding java swing

Question : comment coder un composant double, permettant d’avoir un petit label au dessus d’un champ texte ?

Définition du cahier des charges :

J’ai eu besoin d’un composant Swing qui fonctionnerais comme çà :

  • composant JTextField surmonté d’un JLabel (pour pouvoir savoir à quoi sert le JTextField en très peut de place et en permanence, ce qui explique pourquoi je n’utilise pas un bête popup au survol de la souris)

  • à l’époque j’utilisais NetBeans et son éditeur graphique Matisse, je devais donc faire en sorte que NB veuille bien de ce composant dans sa palette

  • et surtout éviter le codage brouillon à base de JPanel

Test de conception à base de JPanel :

26

Rechercher et préversions :

Mon tout premier jet, fut basé sur l’utilisation d’un JPanel avec un GridBagLayout, et je voulais éviter çà. Mais cela m’a permis de définir facilement l’aspect graphique du composant.

Puis j’ai demandé de l’aide sur le forum de developpez.com, là, on m’a conseillé de dériver du JTextField et de bidouiller les méthodes getInsets(…​) et de rajouter mon composant dans la méthode paint()

Autant le deuxième point n’est pas un problème, autant le premier est assez embêtant. En effet, si on bidouille les insets dans le composant, cela repousse l’endroit où le texte commence, mais pas la bordure externer du JTextField, ce que ne me conviens pas.

Au final, j’ai trouvé là : …​.. comment coder son propre composant, ce qui donne mes 3 classes qui suivent.

A noter : mon code dépend de la libraire de swinglabs, SwingX, parce que je voulais une ombre à mon JLabel, si cela vous embête, vous pouvez modifier le code de la classe interne JAALabel, voir même l’enlever, et remplacer ses appels avec un JLabel standard.

Résultat :

27

Le composant jTextField1 n’est là que pour montrer comment ce comporte ce nouveau composant.

/**
 * @(#)JLabeledTextField.java 03.12.08
 */

package gui.tools.composants.textfield;

import gui.tools.composants.textfield.ui.BasicLabeledTextFieldUI;
import gui.tools.composants.textfield.ui.LabeledTextFieldUI;

import java.awt.Font;

import java.beans.*;

import java.io.Serializable;

import javax.swing.JComponent;
import javax.swing.SwingConstants;
import javax.swing.UIManager;

public class JLabeledTextField extends JComponent implements Serializable
{
	private static final String		uiClassID					= "LabeledTextUI";
	private int						labelHorizontalAlignement	= SwingConstants.LEFT;
	private Font					labelFont					= new Font("Trebuchet MS", Font.ITALIC, 10);
	private String					labelText;
	private PropertyChangeSupport	propertySupport;
	private String					textFieldText;

	public JLabeledTextField()
	{
		this("", "");
	}

	public JLabeledTextField(String labelText, String textFieldText)
	{
		propertySupport = new PropertyChangeSupport(this);
		this.labelText = labelText;
		this.textFieldText = textFieldText;
		this.updateUI();
	}

	@Override
	public void addPropertyChangeListener(PropertyChangeListener listener)
	{
		propertySupport.addPropertyChangeListener(listener);
	}

	@Override
	public void removePropertyChangeListener(PropertyChangeListener listener)
	{
		propertySupport.removePropertyChangeListener(listener);
	}

	public void setUI(LabeledTextFieldUI ui)
	{
		super.setUI(ui);
	}

	@Override
	public void updateUI()
	{
		if(UIManager.get(getUIClassID()) != null)
		{
			setUI((LabeledTextFieldUI) UIManager.getUI(this));
		}
		else
		{
			setUI(BasicLabeledTextFieldUI.createUI(this));
		}
	}

	public LabeledTextFieldUI getUI()
	{
		return (LabeledTextFieldUI) ui;
	}

	@Override
	public String getUIClassID()
	{
		return uiClassID;
	}

	public String getLabelText()
	{
		return labelText;
	}

	public String getTextFieldText()
	{
		return textFieldText;
	}

	public int getLabelHorizontalAlignement()
	{
		return labelHorizontalAlignement;
	}

	public Font getLabelFont()
	{
		return labelFont;
	}

	public void setLabelText(String text)
	{
		this.labelText = text;
		((LabeledTextFieldUI) getUI()).updateLabelText();
	}

	public void setTextFieldText(String text)
	{
		this.textFieldText = text;
		((LabeledTextFieldUI) getUI()).updateTextFieldText();
	}

	public void setLabelFont(Font labelFont)
	{
		this.labelFont = labelFont;
		((LabeledTextFieldUI) getUI()).updateLabelFont();
	}

	public void setLabelHorizontalAlignement(int labelHorizontalAlignement)
	{
		this.labelHorizontalAlignement = labelHorizontalAlignement;
		((LabeledTextFieldUI) getUI()).updateLabelAlignement();
	}
}
/**
 * @(#)BasicFlexiSliderUI.java 03.12.08
 */

package gui.tools.composants.textfield.ui;

import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsEnvironment;
import java.awt.LayoutManager;
import java.awt.RenderingHints;
import java.awt.Transparency;
import java.awt.image.BufferedImage;
import javax.swing.JComponent;
import javax.swing.JTextField;
import gui.tools.composants.textfield.JLabeledTextField;

import javax.swing.border.EmptyBorder;
import javax.swing.plaf.ComponentUI;
import org.jdesktop.swingx.graphics.ShadowRenderer;

public class BasicLabeledTextFieldUI extends LabeledTextFieldUI
{
	protected JLabeledTextField	labeledTextField;
	protected JTextField		textField;
	protected JAALabel			textFieldLabel;

	public static ComponentUI createUI(JComponent c)
	{
		return new BasicLabeledTextFieldUI();
	}

	@Override
	public void installUI(JComponent c)
	{
		this.labeledTextField = (JLabeledTextField) c;
		installComponents();
		c.setLayout(createLayoutManager());
		c.setBorder(new EmptyBorder(1, 1, 1, 1));
	}

	@Override
	public void uninstallUI(JComponent c)
	{
		c.setLayout(null);
		uninstallDefaults();
		this.labeledTextField = null;
	}

	public void installComponents()
	{
		// création du JLabel
		this.textFieldLabel = new JAALabel();

		// configuration
		updateLabelFont();
		updateLabelText();
		updateLabelAlignement();

		// TEST : this.textFieldLabel.setBorder(new LineBorder(Color.red));
		// création du JTextField
		this.textField = new JTextField();

		// configuration
		updateTextFieldText();

		// ajout au composant
		this.labeledTextField.add(this.textFieldLabel);
		this.labeledTextField.add(this.textField);
	}

	public void uninstallDefaults()
	{
		this.labeledTextField.remove(this.textFieldLabel);
		this.labeledTextField.remove(this.textField);
		this.textFieldLabel = null;
		this.textField = null;
	}

	protected LayoutManager createLayoutManager()
	{
		return new LabeledTextFieldLayout();
	}

	@Override
	public void updateLabelText()
	{
		this.textFieldLabel.setText(this.labeledTextField.getLabelText());
	}

	@Override
	public void updateTextFieldText()
	{
		this.textField.setText(this.labeledTextField.getTextFieldText());
	}

	@Override
	public void updateLabelAlignement()
	{
		this.textFieldLabel.setHorizontalAlignment(this.labeledTextField.getLabelHorizontalAlignement());
	}

	@Override
	public void updateLabelFont()
	{
		this.textFieldLabel.setFont(this.labeledTextField.getLabelFont());
	}

	/**
	 * Classe définissant un JLabel avec l'anti-aliasing (et une ombre)
	 */
	protected class JAALabel extends javax.swing.JLabel
	{
		public JAALabel()
		{
			super();
		}

		public JAALabel(String label)
		{
			super(label);
		}

		public JAALabel(String label, int alignment)
		{
			super(label, alignment);
		}

		public JAALabel(String label, javax.swing.ImageIcon icon, int alignment)
		{
			super(label, icon, alignment);
		}

		@Override
		public void paint(java.awt.Graphics g)
		{
			BufferedImage bufImg = GraphicsEnvironment.getLocalGraphicsEnvironment().getDefaultScreenDevice().getDefaultConfiguration().createCompatibleImage(getWidth(), getHeight(), Transparency.TRANSLUCENT);

			Graphics ig = bufImg.getGraphics().create();
			super.paint(ig);
			ig.dispose();

			ShadowRenderer shadow = new ShadowRenderer(1, 0.3f, Color.BLACK);
			// ShadowRenderer shadow = new ShadowRenderer();
			BufferedImage shadowImg = shadow.createShadow(bufImg);

			Graphics2D g2 = (Graphics2D) g;
			g2.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
			g2.setRenderingHint(RenderingHints.KEY_FRACTIONALMETRICS, RenderingHints.VALUE_FRACTIONALMETRICS_ON);

			g.drawImage(shadowImg, 0, 0, null);
			g.drawImage(bufImg, 0, 0, null);
		}

	}

	/**
	 * Classe de disposition des composants
	 */
	protected class LabeledTextFieldLayout implements LayoutManager
	{
		@Override
		public void addLayoutComponent(String name, Component c)
		{
		}

		@Override
		public void removeLayoutComponent(Component c)
		{
		}

		@Override
		public Dimension preferredLayoutSize(Container c)
		{
			int width = 0;
			int height = 0;

			height = textFieldLabel.getPreferredSize().height + textField.getPreferredSize().height;
			width = textField.getPreferredSize().width > textFieldLabel.getPreferredSize().width ? textField.getPreferredSize().width : textFieldLabel.getPreferredSize().width;

			return new Dimension(width, height);
		}

		@Override
		public Dimension minimumLayoutSize(Container c)
		{
			return this.preferredLayoutSize(c);
		}

		@Override
		public void layoutContainer(Container c)
		{
			textFieldLabel.setBounds(0, 0, c.getWidth(), textFieldLabel.getPreferredSize().height);
			textField.setBounds(0, textFieldLabel.getPreferredSize().height, c.getWidth(), c.getHeight() - textFieldLabel.getPreferredSize().height);
		}
	}
}
/**
 * @(#)FlexiSliderUI.java 03.12.08
 */

package gui.tools.composants.textfield.ui;

import javax.swing.plaf.ComponentUI;

public abstract class LabeledTextFieldUI extends ComponentUI
{
	public abstract void updateLabelText();

	public abstract void updateTextFieldText();

	public abstract void updateLabelAlignement();

	public abstract void updateLabelFont();
}