xy.reflect.ui.util.component.AbstractControlButton Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (C) 2018 OTK Software
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * 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.
 * 
 * The GNU General Public License allows you also to freely redistribute 
 * the libraries under the same license, if you provide the terms of the 
 * GNU General Public License with them and add the following 
 * copyright notice at the appropriate place (with a link to 
 * http://javacollection.net/reflectionui/ web site when possible).
 ******************************************************************************/
package xy.reflect.ui.util.component;

import java.awt.Color;
import java.awt.Graphics;
import java.awt.Image;

import javax.swing.BorderFactory;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.plaf.basic.BasicBorders;

import xy.reflect.ui.control.swing.renderer.SwingRenderer;
import xy.reflect.ui.info.app.IApplicationInfo;
import xy.reflect.ui.util.ReflectionUIUtils;
import xy.reflect.ui.util.SwingRendererUtils;

public abstract class AbstractControlButton extends JButton {

	protected static final long serialVersionUID = 1L;

	public abstract SwingRenderer getSwingRenderer();

	public abstract String retrieveCaption();

	private boolean initialized = false;
	private SwingRenderer swingRenderer;
	private IApplicationInfo applicationInfo;
	private Color backgroundColor;
	private Color activatedBackgroundColor;
	private Color foregroundColor;
	private Color borderColor;
	private Image backgroundImage;
	private Image activatedBackgroundImage;
	private String caption;
	private String toolTipText;
	private Icon icon;

	protected boolean isApplicationInfoStyleLoaded() {
		return true;
	}

	protected boolean isApplicationStyleButtonSpecific() {
		return true;
	}

	public Image retrieveBackgroundImage() {
		if (!isApplicationInfoStyleLoaded()) {
			return null;
		}
		if (isApplicationStyleButtonSpecific()) {
			if (applicationInfo.getButtonBackgroundImagePath() == null) {
				return null;
			} else {
				return SwingRendererUtils.loadImageThroughcache(applicationInfo.getButtonBackgroundImagePath(),
						ReflectionUIUtils.getErrorLogListener(swingRenderer.getReflectionUI()));
			}
		} else {
			return null;
		}
	}

	public Color retrieveBackgroundColor() {
		if (!isApplicationInfoStyleLoaded()) {
			return null;
		}
		if (isApplicationStyleButtonSpecific()) {
			if (applicationInfo.getButtonBackgroundColor() == null) {
				return null;
			} else {
				return SwingRendererUtils.getColor(applicationInfo.getButtonBackgroundColor());
			}
		} else {
			if (applicationInfo.getMainBackgroundColor() == null) {
				return null;
			} else {
				return SwingRendererUtils.getColor(applicationInfo.getMainBackgroundColor());
			}
		}
	}

	public Color retrieveForegroundColor() {
		if (!isApplicationInfoStyleLoaded()) {
			return null;
		}
		if (isApplicationStyleButtonSpecific()) {
			if (applicationInfo.getButtonForegroundColor() == null) {
				return null;
			} else {
				return SwingRendererUtils.getColor(applicationInfo.getButtonForegroundColor());
			}
		} else {
			if (applicationInfo.getMainForegroundColor() == null) {
				return null;
			} else {
				return SwingRendererUtils.getColor(applicationInfo.getMainForegroundColor());
			}
		}
	}

	public Color retrieveBorderColor() {
		if (!isApplicationInfoStyleLoaded()) {
			return null;
		}
		if (isApplicationStyleButtonSpecific()) {
			if (applicationInfo.getButtonBorderColor() == null) {
				return null;
			} else {
				return SwingRendererUtils.getColor(applicationInfo.getButtonBorderColor());
			}
		} else {
			if (applicationInfo.getMainForegroundColor() == null) {
				return null;
			} else {
				return SwingRendererUtils.getColor(applicationInfo.getMainForegroundColor());
			}
		}
	}

	public String retrieveToolTipText() {
		return null;
	}

	public Icon retrieveIcon() {
		return null;
	}

	public void initializeStyle() {
		swingRenderer = getSwingRenderer();
		applicationInfo = swingRenderer.getReflectionUI().getApplicationInfo();
		backgroundColor = retrieveBackgroundColor();
		foregroundColor = retrieveForegroundColor();
		borderColor = retrieveBorderColor();
		backgroundImage = retrieveBackgroundImage();
		activatedBackgroundColor = (backgroundColor == null) ? null
				: swingRenderer.addColorActivationEffect(backgroundColor);
		activatedBackgroundImage = (backgroundImage == null) ? null
				: swingRenderer.addImageActivationEffect(backgroundImage);
		caption = retrieveCaption();
		toolTipText = retrieveToolTipText();
		icon = retrieveIcon();

		setText(getSwingRenderer().prepareStringToDisplay(caption));
		if ((toolTipText != null) && (toolTipText.length() > 0)) {
			SwingRendererUtils.setMultilineToolTipText(this, getSwingRenderer().prepareStringToDisplay(toolTipText));
		}
		setIcon(icon);
		if (backgroundColor != null) {
			setBackground(backgroundColor);
		}
		if (foregroundColor != null) {
			setForeground(foregroundColor);
		}
		if (borderColor != null) {
			setBorder(BorderFactory.createCompoundBorder(BorderFactory.createLineBorder(borderColor),
					new BasicBorders.MarginBorder()));
		}
		if ((backgroundImage != null) || (backgroundColor != null)) {
			setContentAreaFilled(false);
		}
		if (isApplicationInfoStyleLoaded()) {
			if (!isApplicationStyleButtonSpecific()) {
				if (applicationInfo.getMainBackgroundImagePath() != null) {
					setContentAreaFilled(false);
				}
			}
		}
		if (backgroundImage != null) {
			setBorderPainted(false);
		}
	}

	@Override
	public void addNotify() {
		if (!initialized) {
			initializeStyle();
			initialized = true;
		}
		super.addNotify();
	}

	@Override
	protected void paintComponent(Graphics g) {
		if (backgroundImage != null) {
			if (getModel().isArmed()) {
				g.drawImage(activatedBackgroundImage.getScaledInstance(getWidth(), getHeight(), Image.SCALE_SMOOTH), 0,
						0, null);
			} else {
				g.drawImage(backgroundImage.getScaledInstance(getWidth(), getHeight(), Image.SCALE_SMOOTH), 0, 0, null);
			}
		} else if (backgroundColor != null) {
			if (getModel().isArmed()) {
				g.setColor(activatedBackgroundColor);
				g.fillRect(0, 0, getWidth(), getHeight());
			} else if (getModel().isEnabled()) {
				g.setColor(backgroundColor);
				g.fillRect(0, 0, getWidth(), getHeight());
			}
		}
		super.paintComponent(g);
	}

}