MultiStyleUIConfigProvider

一、特殊名词介绍

无

二、背景、场景介绍

在制作模板的过程中，每个用户公司都会逐渐形成自身的一套特有的样式风格，为了方便用户快速配置样式，报表设计器中提供了预定义样式的功能，以便让用户快速配置报表的样式。标准设计器中提供了基本的格式、字体、对齐、边框、背景的预定义。但是样式中还可能包含其他属性可自由定义的。MultiStyleUIConfigProvider和StyleUIConfigProvider接口就是用来提供自定义的样式配置扩展的

三、接口介绍

package com.fr.design.fun;

import com.fr.common.annotations.Open;
import com.fr.stable.fun.mark.Mutable;

import java.util.List;

/**
 * Created by kerry on 2019-11-11
 */
@Open
public interface MultiStyleUIConfigProvider extends Mutable {
    String XML_TAG = "MultiStyleUIConfigProvider";

    int CURRENT_LEVEL = 1;

    /**
     * 获取配置项list
     *
     * @return 配置项list
     */
    List<StyleUIConfigProvider> getConfigList();
}

package com.fr.design.fun;

import com.fr.base.Style;
import com.fr.common.annotations.Open;
import com.fr.stable.fun.mark.Mutable;

import javax.swing.JComponent;
import javax.swing.event.ChangeListener;

/**
 * Created by kerry on 2019-11-11
 */
@Open
public interface StyleUIConfigProvider extends Mutable {
    String XML_TAG = "CustomStyleUIConfigProvider";

    int CURRENT_LEVEL = 1;

    /**
     * @return 配置名
     */
    String configName();

    /**
     * @param changeListener 需要添加的listener
     * @return 对应的component
     */
    JComponent uiComponent(ChangeListener changeListener);

    /**
     * @return 更新后的样式
     */
    Style updateConfig();

    /**
     * @param style 待渲染的样式
     */
    void populateConfig(Style style);
}

四、支持版本

五、插件注册

<extra-designer>
    <!-- 批量插入选项卡 -->
    <MultiStyleUIConfigProvider class="your class name"/>
</extra-designer>

六、原理说明

package com.fr.design.style;

import com.fr.base.CellBorderStyle;
import com.fr.base.NameStyle;
import com.fr.base.ScreenResolution;
import com.fr.base.Style;
import com.fr.base.core.StyleUtils;
import com.fr.design.ExtraDesignClassManager;
import com.fr.design.beans.BasicBeanPane;
import com.fr.design.dialog.FineJOptionPane;
import com.fr.design.fun.MultiStyleUIConfigProvider;
import com.fr.design.fun.StyleUIConfigProvider;
import com.fr.design.gui.frpane.UITabbedPane;
import com.fr.design.layout.FRGUIPaneFactory;
import com.fr.design.mainframe.ElementCasePane;
import com.fr.design.style.background.BackgroundPane;
import com.fr.design.utils.gui.GUICoreUtils;
import com.fr.grid.selection.CellSelection;
import com.fr.grid.selection.FloatSelection;
import com.fr.grid.selection.Selection;
import com.fr.log.FineLoggerFactory;
import com.fr.plugin.solution.sandbox.collection.PluginSandboxCollections;
import com.fr.report.cell.CellElement;
import com.fr.report.cell.DefaultTemplateCellElement;
import com.fr.report.cell.FloatElement;
import com.fr.report.cell.TemplateCellElement;
import com.fr.report.elementcase.ElementCase;
import com.fr.report.elementcase.TemplateElementCase;

import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JTabbedPane;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.util.List;
import java.util.Set;

/**
 * Style Pane.
 */
public class StylePane extends BasicBeanPane<Style> implements ChangeListener {
    private static final int BORDER_ARRAY_LENGTH = 4;
    private static final int ALIGNMENT_INDEX = 1;
    private static final int FONT_INDEX = 2;
    private static final int BORDER_INDEX = 3;
    private static final int BACKGROUND_INDEX = 4;
    private static final int NEXT_TAB_INDEX = 5;
    private ElementCasePane reportPane;
    protected Style editing;
    private NameStyle globalStyle;
    private FormatPane formatPane = null;
    private AlignmentPane alignmentPane = null;
    private FRFontPane frFontPane = null;
    private BorderPane borderPane = null;
    private BackgroundPane backgroundPane = null;
    private static List<StyleUIConfigProvider> configList = PluginSandboxCollections.newSandboxList();
    private PreivewArea previewArea;
    private JPanel previewPane;

    static {
        Set<MultiStyleUIConfigProvider> preferenceConfigProviders = ExtraDesignClassManager.getInstance().getArray(MultiStyleUIConfigProvider.XML_TAG);
        for (MultiStyleUIConfigProvider provider : preferenceConfigProviders) {
            configList.addAll(provider.getConfigList());
        }
    }

    /**
     * Constructor
     */
    public StylePane() {
        this.setLayout(FRGUIPaneFactory.createBorderLayout());

        previewPane = FRGUIPaneFactory.createBorderLayout_S_Pane();
        this.add(previewPane, BorderLayout.NORTH);
        previewPane.setBorder(GUICoreUtils.createTitledBorder(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Basic_Preview"), null));

        previewArea = new PreivewArea();
        previewPane.add(previewArea, BorderLayout.CENTER);

        JPanel previewControlPane = FRGUIPaneFactory.createNColumnGridInnerContainer_S_Pane(1);
        previewPane.add(previewControlPane, BorderLayout.EAST);

        UITabbedPane mainTabbedPane = new UITabbedPane();
        this.add(mainTabbedPane, BorderLayout.CENTER);

        mainTabbedPane.addTab(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Chart_Format"), this.getFormatPane());
        mainTabbedPane.addTab(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Report_Alignment"), FRGUIPaneFactory.createY_AXISBoxInnerContainer_L_Pane());
        mainTabbedPane.addTab(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Basic_Sytle_FRFont"), FRGUIPaneFactory.createY_AXISBoxInnerContainer_L_Pane());
        mainTabbedPane.addTab(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Report_Border"), FRGUIPaneFactory.createY_AXISBoxInnerContainer_L_Pane());
        mainTabbedPane.addTab(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Basic_Background"), FRGUIPaneFactory.createY_AXISBoxInnerContainer_L_Pane());

        for (StyleUIConfigProvider config : configList) {
            mainTabbedPane.addTab(config.configName(), FRGUIPaneFactory.createY_AXISBoxInnerContainer_L_Pane());
        }
        mainTabbedPane.addChangeListener(tabChangeActionListener);
        this.setPreferredSize(new Dimension(450, 480));
    }

    @Override
    protected String title4PopupWindow() {
        return com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Basic_Style");
    }

    public void stateChanged(ChangeEvent e) {
        this.updatePreviewArea();
    }

    protected FormatPane getFormatPane() {
        if (this.formatPane == null) {
            this.formatPane = new FormatPane();
            if (this.editing != null) {
                this.formatPane.populate(this.editing.getFormat());
            }
        }

        return this.formatPane;
    }

    private AlignmentPane getAlignmentPane() {
        if (this.alignmentPane == null) {
            this.alignmentPane = new AlignmentPane();
            this.alignmentPane.addChangeListener(this);
            if (this.editing != null) {
                this.alignmentPane.populate(this.editing);
            }
        }

        return this.alignmentPane;
    }

    private FRFontPane getFRFontPane() {
        if (this.frFontPane == null) {
            this.frFontPane = new FRFontPane();
            this.frFontPane.addChangeListener(this);
            if (this.editing != null) {
                this.frFontPane.populate(this.editing.getFRFont());
            }
        }

        return this.frFontPane;
    }

    class FRFontListSelectionListener implements ListSelectionListener {

        public void valueChanged(ListSelectionEvent e) {
            updatePreviewArea();
        }
    }

    private BorderPane getBorderPane() {
        if (this.borderPane == null) {
            this.borderPane = new BorderPane();
            this.borderPane.addChangeListener(this);

            // p:borderPane这边比较特殊，单元格的Style的时候，
            // 用reportPane,在全局Style的时候用oldStyle
            if (this.reportPane != null) {
                Object[] fourObjectArray = BorderUtils.createCellBorderObject(reportPane);

                if (fourObjectArray != null && fourObjectArray.length == BORDER_ARRAY_LENGTH) {
                    this.borderPane.populate((CellBorderStyle) fourObjectArray[0], ((Boolean) fourObjectArray[1]).booleanValue(),
                            ((Integer) fourObjectArray[2]).intValue(), (Color) fourObjectArray[3]);
                }
            } else {
                if (this.editing != null) {
                    this.borderPane.populate(this.editing);
                }
            }
        }

        return this.borderPane;
    }

    private BackgroundPane getBackgroundPane() {
        if (this.backgroundPane == null) {
            this.backgroundPane = new BackgroundPane();
            this.backgroundPane.addChangeListener(this);
            if (this.editing != null) {
                this.backgroundPane.populate(this.editing.getBackground());
            }
        }

        return this.backgroundPane;
    }

    public NameStyle getGlobalStyle() {
        return this.globalStyle;
    }

    public void setGlobalStyle(NameStyle globalStyle) {
        this.globalStyle = globalStyle;
    }

    /**
     * Populate
     */
    public void populate(ElementCasePane reportPane) {
        // p:保留ReportPane, 给BorderPane使用.
        this.reportPane = reportPane;
        this.populateBean(this.analyzeCurrentStyle(reportPane));
        updatePreviewArea();
    }

    /**
     * 分析Style
     */
    private Style analyzeCurrentStyle(ElementCasePane reportPane) {
        Style style = null;

        // p:从选中的CellElement那里先获得原始的Style.
        Selection sel = reportPane.getSelection();
        if (sel instanceof FloatSelection) {
            // got simple cell element from column and row.
            ElementCase report = reportPane.getEditingElementCase();

            FloatElement selectedFloatElement = report.getFloatElement(((FloatSelection) sel).getSelectedFloatName());
            style = selectedFloatElement.getStyle();
        } else {
            CellSelection cs = (CellSelection) sel;

            // got simple cell element from column and row.
            ElementCase report = reportPane.getEditingElementCase();
            CellElement editCellElement = report.getCellElement(cs.getColumn(), cs.getRow());

            if (editCellElement != null && editCellElement.getStyle() != null) {// editCellElement
                                                                                // cellstyle.
                try {
                    style = (Style) editCellElement.getStyle().clone();
                } catch (CloneNotSupportedException e) {
                    FineLoggerFactory.getLogger().error(e.getMessage(), e);
                }
            }
        }

        if (style == null) {
            // peter:获取默认的Style.
            style = Style.DEFAULT_STYLE;
        }

        return style;
    }

    /**
     * 使用全局定义的格式
     */
    public boolean updateGlobalStyle(ElementCasePane reportPane) {
        updatePreviewArea();
        NameStyle nameStyle = this.getGlobalStyle();

        return applyStyle(reportPane, new NameStyleG(nameStyle));
    }

    /**
     * Update. Return whether style changed.
     */
    public boolean update(ElementCasePane reportPane) {
        Style oldStyle = analyzeCurrentStyle(reportPane);

        return applyStyle(reportPane, new NormalStyleG(oldStyle, this.updateBean()));
    }

    private static abstract class GStyle {
        protected abstract Style getStyle2Apply(Style styleOfEl);
    }

    private static class NameStyleG extends GStyle {
        NameStyle nameStyle;

        NameStyleG(NameStyle nameStyle) {
            this.nameStyle = nameStyle;
        }

        @Override
        protected Style getStyle2Apply(Style styleOfEl) {
            return nameStyle;
        }
    }

    private static class NormalStyleG extends GStyle {
        Style styleOfReportPane;
        Style newStyle;

        NormalStyleG(Style styleOfReportPane, Style newStyle) {
            this.styleOfReportPane = styleOfReportPane;
            this.newStyle = newStyle;
        }

        @Override
        protected Style getStyle2Apply(Style styleOfEl) {
            return StyleUtils.applyCellStyle(styleOfReportPane, newStyle, styleOfEl);
        }
    }

    private boolean applyStyle(ElementCasePane reportPane, GStyle gstyle) {
        TemplateElementCase report = reportPane.getEditingElementCase();
        Selection sel = reportPane.getSelection();
        if (sel instanceof FloatSelection) {
            FloatElement floatElement = report.getFloatElement(((FloatSelection) sel).getSelectedFloatName());

            // Apply style.
            floatElement.setStyle(gstyle.getStyle2Apply(floatElement.getStyle()));
        } else {
            CellSelection cs = (CellSelection) sel;
            // Got editCellElement.
            TemplateCellElement editCellElement;

            // 需要先行后列地增加新元素。
            for (int j = 0; j < cs.getRowSpan(); j++) {
                for (int i = 0; i < cs.getColumnSpan(); i++) {
                    int column = i + cs.getColumn();
                    int row = j + cs.getRow();

                    editCellElement = report.getTemplateCellElement(column, row);
                    if (editCellElement == null) {
                        editCellElement = new DefaultTemplateCellElement(column, row);
                        report.addCellElement(editCellElement);
                    }

                    // Apply cellstyle.
                    editCellElement.setStyle(gstyle.getStyle2Apply(editCellElement.getStyle()));
                }
            }
        }

        // p:因为borderpane特殊，update borderpane
        if (this.borderPane != null) {
            BorderUtils.update(reportPane, this.borderPane.update());
        }
        reportPane.repaint();
        return true;
    }

    /**
     * Populate Style
     */
    @Override
    public void populateBean(Style ob) {
        this.editing = ob == null ? Style.getInstance() : ob;

        if (this.formatPane != null) {
            this.formatPane.populate(editing.getFormat());
        }
        if (this.alignmentPane != null) {
            this.alignmentPane.populate(editing);
        }
        if (this.frFontPane != null) {
            this.frFontPane.populate(editing.getFRFont());
        }
        if (this.borderPane != null) {
            this.borderPane.populate(editing);
        }
        if (this.backgroundPane != null) {
            this.backgroundPane.populate(editing.getBackground());
        }
        for(StyleUIConfigProvider tabConfig : configList){
            tabConfig.populateConfig(this.editing);
        }
        updatePreviewArea();
    }

    /**
     * Update Style
     */
    @Override
    public Style updateBean() {
        // need the check the valid of CellAlignment pane.
        try {
            if (this.alignmentPane != null) {
                this.alignmentPane.checkValid();
            }
        } catch (Exception exp) {
            FineJOptionPane.showMessageDialog(this, exp.getMessage());
            return editing;
        }

        Style style = editing;
        if (this.formatPane != null) {
            style = style.deriveFormat(this.formatPane.update());
        }
        if (this.alignmentPane != null) {
            style = this.alignmentPane.update(style);
        }
        if (this.frFontPane != null) {
            style = style.deriveFRFont(this.frFontPane.update());
        }
        if (this.borderPane != null) {
            style = this.borderPane.update(style);
        }
        if (this.backgroundPane != null) {
            style = style.deriveBackground(this.backgroundPane.update());
        }
        for(StyleUIConfigProvider tabConfig : configList){
            style = tabConfig.updateConfig();
        }

        return style;
    }

    protected ChangeListener tabChangeActionListener = new ChangeListener() {

        public void stateChanged(ChangeEvent evt) {
            Object tabObj = evt.getSource();
            if (tabObj == null || !(tabObj instanceof JTabbedPane)) {
                return;
            }
            JTabbedPane tabbedPane = (JTabbedPane) tabObj;

            int selectedIndex = tabbedPane.getSelectedIndex();
            if (tabbedPane.getComponentAt(selectedIndex).getClass() == JPanel.class) {// 是JPanel,需要替换
                if (selectedIndex == ALIGNMENT_INDEX) {
                    tabbedPane.setComponentAt(selectedIndex, StylePane.this.getAlignmentPane());
                } else if (selectedIndex == FONT_INDEX) {
                    tabbedPane.setComponentAt(selectedIndex, StylePane.this.getFRFontPane());
                } else if (selectedIndex == BORDER_INDEX) {
                    tabbedPane.setComponentAt(selectedIndex, StylePane.this.getBorderPane());
                } else if (selectedIndex == BACKGROUND_INDEX) {
                    tabbedPane.setComponentAt(selectedIndex, StylePane.this.getBackgroundPane());
                } else if (configList.size() + NEXT_TAB_INDEX > selectedIndex && configList.get(selectedIndex - NEXT_TAB_INDEX) != null) {
                    tabbedPane.setComponentAt(selectedIndex, configList.get(selectedIndex - NEXT_TAB_INDEX).uiComponent(StylePane.this));
                    configList.get(selectedIndex - NEXT_TAB_INDEX).populateConfig(StylePane.this.editing);
                }
            }
            updatePreviewArea();
        }
    };

    public void updatePreviewArea() {
        if (editing != null) {
            previewArea.setStyle(this.updateBean());
        }
    }

    public PreivewArea getPreviewArea() {
        return this.previewArea;
    }

    /**
     * 预览Style的面板
     *
     * @author richer
     */
    public static class PreivewArea extends JComponent {

        private String paintText = "Report";
        private Style style = Style.DEFAULT_STYLE;

        public PreivewArea() {
            setPreferredSize(new Dimension(40, 40));
        }

        public void setStyle(Style style) {
            this.style = style;
            repaint();
        }

        @Override
        public void paintComponent(Graphics g) {
            Graphics2D g2d = (Graphics2D) g;
            int resolution = ScreenResolution.getScreenResolution();

            if (style == Style.DEFAULT_STYLE) {
                // 如果是默认的style,就只写"Report"上去
                Style.paintContent(g2d, paintText, style, getWidth() - 3, getHeight() - 3, resolution);
                return;
            }

            Style.paintBackground(g2d, style, getWidth() - 3, getHeight() - 3);

            Style.paintContent(g2d, paintText, style, getWidth() - 3, getHeight() - 3, resolution);

            Style.paintBorder(g2d, style, getWidth() - 3, getHeight() - 3);
        }

        @Override
        public Dimension getMinimumSize() {
            return getPreferredSize();
        }
    }

}

七、特殊限制说明

StyleUIConfigProvider从形式上看也是一个插件接口，但是实际上目前已经不能单独使用了。统一通过MultiStyleUIConfigProvider引入。

八、常用链接

demo-multi-style-ui-config-provider

九、开源案例

免责声明：所有文档中的开源示例，均为开发者自行开发并提供。仅用于参考和学习使用，开发者和官方均无义务对开源案例所涉及的所有成果进行教学和指导。若作为商用一切后果责任由使用者自行承担。

暂无