Qedeq2UnicodeTextPlugin.java
01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02  *
03  * Copyright 2000-2013,  Michael Meyling <mime@qedeq.org>.
04  *
05  * "Hilbert II" is free software; you can redistribute
06  * it and/or modify it under the terms of the GNU General Public
07  * License as published by the Free Software Foundation; either
08  * version 2 of the License, or (at your option) any later version.
09  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  */
15 
16 package org.qedeq.kernel.bo.service.unicode;
17 
18 import org.qedeq.base.io.Parameters;
19 import org.qedeq.kernel.bo.common.PluginExecutor;
20 import org.qedeq.kernel.bo.module.KernelQedeqBo;
21 import org.qedeq.kernel.bo.module.PluginBo;
22 
23 
24 /**
25  * Plugin to transfer a QEDEQ module into a UTF-8 text file.
26  *
27  @author  Michael Meyling
28  */
29 public final class Qedeq2UnicodeTextPlugin implements PluginBo {
30 
31     /** This class. */
32     public static final Class CLASS = Qedeq2UnicodeTextPlugin.class;
33 
34     /**
35      * Constructor.
36      */
37     public Qedeq2UnicodeTextPlugin() {
38     }
39 
40     public String getPluginId() {
41         return CLASS.getName();
42     }
43 
44     public String getPluginActionName() {
45         return "Show Module as UTF-8 text";
46     }
47 
48     public String getPluginDescription() {
49         return "shows QEDEQ module within window as UTF-8 text";
50     }
51 
52     public PluginExecutor createExecutor(final KernelQedeqBo qedeq, final Parameters parameters) {
53         return new Qedeq2UnicodeTextExecutor(this, qedeq, parameters);
54     }
55 
56     public void setDefaultValuesForEmptyPluginParameters(final Parameters parameters) {
57         parameters.setDefault("language""en");
58         parameters.setDefault("info"true);
59         parameters.setDefault("brief"false);
60         // automatically line break after this column. 0 means no automatic line breaking
61         parameters.setDefault("maximumColumn"80);
62     }
63 
64 }