CIB jrec technischer Leitfaden

1. Lieferumfang

Nach dem Auspacken ergibt sich folgende Verzeichnisstruktur mit den angegebenen Dateien:

2. Einführung

CIB jrec ist eine Java basierte Rich-Text Editor-Komponente, die sich nach dem von anderen CIB Modulen bekannten Schnittstellenkonzept einfach in Masken und fremde Anwendungen integrieren lässt.

Wie die anderen CIB Module kann dieses RTF-Edit-Control komfortabel durch Setzen verschiedener Properties gesteuert werden. Damit erfüllt sich ein häufiger Kundenwunsch nach einem schlanken Text(passagen)-Editor mit reduziertem Funktionsumfang, der einfach in andere Java-Anwendungen eingebunden werden kann.

Der CIB jrec Editor kann entweder leer, mit ASCII oder RTF-Texten gestartet werden. Umgekehrt können die Texte wieder im ASCII- oder RTF-Format aus dem Edit-Control gelesen werden.

CIB jrec besitzt folgende Möglichkeiten zur Textformatierung:

• Verschiedene Schriftarten und Schriftgrößen
• Zeichenattribute fett, kursiv, unterstrichen, farbig
• Absatzausrichtung linksbündig, zentriert, rechtsbündig
• Kopieren, Ausschneiden und Einfügen markierter Textabschnitte
• Ein-/Ausblenden von Formatierungszeichen

In einem RTF-Dokument vorhandene Tabulatorpositionen (dokumentübergreifend oder pro Absatz) werden ausgewertet und entsprechend angezeigt.

Die vorliegende technische Dokumentation gibt einen Überblick über die Konfigurations- und Einsatzmöglichkeiten nebst Codebeispielen für einen "schnellen Einstieg" in die Thematik.

Im Folgenden werden zwei Beispieldokumente dargestellt: Das erste Dokument wurde mit CIB jrec erstellt und zeigt beispielhaft einige Funktionen des Rich-Text Edit-Controls. Das zweite Dokument enthält verschiedene Tabulatoren und wurde mit MS Word erstellt, da in CIB jrec Dokumente mit expliziten Tabulatorpositionen zwar angezeigt, aber nicht erzeugt werden können.

3. Konfiguration durch Properties

In diesem Kapitel können Sie Konfiguration durch Properties finden.

3.1. Allgemeine Properties

Mit den folgenden Properties können generelle Einstellung für die Applikation gesetzt werden.

3.2. Properties zur Konfiguration der Toolbar

Mit den folgenden Properties können die einzelnen Elemente der Toolbar aus- oder eingeschaltet werden. Setzen der Property auf TRUE bewirkt, dass das Element sichtbar und aktiv ist, FALSE bedeutet, das Element ist unsichtbar und deaktiviert. 

3.3. Properties zur Konfiguration des jrec Edit-Controls

Mit diesen Properties kann das Verhalten des jrec Edit-Controls gesteuert werden. 

4. Steuerung durch Aufrufparameter

CIB jrec kann auch durch Aufrufparameter in der Batch-Datei (run.bat) gesteuert werden.

Dabei gilt die übliche Syntax für Kommandozeilenparameter:

-<Parametername-1> <Parameterwert-1> … -<Parametername-n> <Parameterwert-n>

Die Namen der Parameter entsprechen den internen Namen der Properties. Falls nicht bekannt, können sie durch den Support erfragt werden.

Zusätzlich gibt es folgende Aufrufparameter:

<Dateiname>      Name des Dokuments, das beim Start der Applikation geladen werden soll. (ohne vorausgehendes Minuszeichen)

-t                          Aktiviert die Ausgabe von Trace-Informationen in die Konsole

5. Konfigurationsdatei (INI-Datei)

CIB jrec kann durch eine Konfigurationsdatei gesteuert werden. Falls durch die Property PROPERTY_JREC_INIFILENAME kein anderer Name gesetzt wird, ist der Name der INI-Datei standardmäßig „cibjrec.ini“. Wenn keine INI-Datei verwendet werden soll, muss die INI-Datei auf den Wert „null“ gesetzt werden.

Die INI-Datei wird beim Start von CIB jrec gelesen (in der Methode cibRec.start) und kann prinzipiell alle oben beschriebenen Properties enthalten, die dann die vorher gesetzten Property-Werte überschreiben.

Die Namen der Properties müssen den internen Namen der Properties entsprechen. Falls nicht bekannt, können sie durch den Support erfragt werden.

Beginnt eine Zeile mit „#“, wird die Property ignoriert.

Beispiel für den Inhalt einer INI-Datei:

[Properties]
TITLE=CIB Java Rich Edit Control
INPUTFILE=D:\CIB\TestDokumente\RTF\Tabtest_All.rtf
 
# Enable popup menu
popup.Enabled=true
 
# Show status line
showstatus.Enabled=true
 
# Show toolbar icon for nonprintable-characters
#show-nonprintable-chars.Enabled=false
 
# Set default font family and size
defaultFontFamily=Arial
defaultFontSize=10
 
# Write default font size on saving
writeDefaultFontSize=true
 
# Write default tabs on saving
#writeDefaultTabs=true
 
# Grab focus after setting rtf file
#grab.focus.after.setrtf.Enabled=false
 
# Ignore field instructions within rtf content
#JREC.ignoreFields=true

6. Einbindung des CIB jrec in Java

Wird der Jrec in eine Java-Applikation eingebunden, die ein eigenes Menü besitzt, muss das JRec-Menü explizit deaktiviert werden. Dazu muss bei der Jrec-Instanz folgende Property gesetzt werden, bevor die Jrec-Instanz gestartet wird:

      // disable jrec menu bar – must be done 
      // if custom application uses its own menu bar

 m_cibRec.setProperty(ICibApplication.PROPERTY_MENU_ENABLED,
            Boolean.FALSE);
 
      // set other Properties
      //...
      
      // jrec start and load
      m_cibRec.start();
      m_cibRec.load();

 Siehe dazu auch den Beispielcode zur Einbindung in eine Java Swing-Applikation.

6.1. Einbindung in eine Java Swing-Applikation

import java.awt.Dimension;
 
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.WindowConstants;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.SimpleAttributeSet;
import javax.swing.text.StyleConstants;
 
import de.cib.jrec.JCibRec;
 
public class MyRecTest extends JFrame {
 
      private static final long serialVersionUID = 1L;
      public static final String TEST_FILENAME = "c://tmp//rtf_data.rtf";
 
      JCibRec m_cibRec;
 
      public MySwingRecTest() {
            m_cibRec = new JCibRec();
 
            JPanel recPanel = new JPanel();
            recPanel.add(m_cibRec);
            getContentPane().add(recPanel);
            m_cibRec.setPreferredSize(new Dimension(650, 200));
 
            // set standard formatting
            initDocumentAttributes();
 
            // set input file (optional)
            m_cibRec.setProperty(ICibApplication.PROPERTY_INPUTFILE,
                        TEST_FILENAME);
            // set Jrec application title
            m_cibRec.setProperty(ICibApplication.PROPERTY_TITLE,
                  "CIB JRec integriert in Swing");
            // disable jrec menu bar – must be done 

            // if custom application uses its own menu bar
            // if custom application uses its own menu bar
            m_cibRec.setProperty(ICibApplication.PROPERTY_MENU_ENABLED,
                  Boolean.FALSE);
 
            // set other Properties
            //...
            
            // jrec start and load
            m_cibRec.start();
            m_cibRec.load();
 
       setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
 
            setLocation(200, 50);
            setResizable(false);
            pack();
      }
 
      // set standard formatting
      private void initDocumentAttributes() {
            MutableAttributeSet defaultAttributes = 
                        new SimpleAttributeSet();
 
       StyleConstants.setFontSize(defaultAttributes, 8);
       StyleConstants.setFontFamily(defaultAttributes, "Courier New");
 
       m_cibRec.getRecRichEditPane().setDocumentAttributeDefaults(
                        defaultAttributes);
      }
 
      public static void main(String[] args)
      {
            MySwingRecTest recTest = new MySwingRecTest();
            recTest.setVisible(true);
      }
}

 Die Funktion initDocumentAttributes() zeigt beispielhaft, wie Sie die standardmäßige Schriftart und Schriftgröße für das Dokument setzen können.

6.2. Einbindung in eine Java SWT-Applikation

Um JCibRec in eine SWT-Applikation zu integrieren, müssen einige Besonderheiten beachtet werden. JCibRec muss in einen AWT-Frame eingebettet werden, der als oberstes Objekt eine Instanz von RootPaneContainer (z.B. JApplet) enthält. In diesen RootPaneContainer werden dann alle weiteren Komponenten eingefügt.

import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
 
import de.cib.gui.framework.ICibApplication;
import de.cib.jrec.ICibRecApplication;
import de.cib.jrec.JCibRec;
 
 
public class JRecInSWT {
 
      public static final String TEST_FILENAME = "Testdokument2.rtf";
 
      public static void main(String[] args) {
            final Display display = new Display();
            final Shell shell = new Shell(display);
            shell.setLayout(new FillLayout());
            shell.setText("Shell for JRec integriert in SWT");
            Composite composite = new Composite(shell, SWT.NO_BACKGROUND
                        | SWT.EMBEDDED);
            
            /*
             * Set a Windows specific AWT property that prevents 
             * heavyweight components from erasing their background. 
             * Note that this is a global property and cannot be scoped. 
             * It might not be suitable for your application.
             */
            try {
                System.setProperty("sun.awt.noerasebackground", "true");
            }
            catch (NoSuchMethodError error) {
            }
 
            final JCibRec cibRec = new JCibRec(composite);
            
       cibRec.setProperty(ICibApplication.PROPERTY_INPUTFILE,
                  TEST_FILENAME);
       cibRec.setProperty(ICibApplication.PROPERTY_TITLE,
                  "CIB JRec integriert in SWT");
       cibRec.setProperty(ICibRecApplication.PROPERTY_POPUP_ENABLED,
                  Boolean.TRUE);
 
            // disable jrec menu bar – must be done 
            // if custom application uses its own menu bar
       cibRec.setProperty(ICibApplication.PROPERTY_MENU_ENABLED,
                  Boolean.FALSE);
 
            
            cibRec.setVisible(true);
            cibRec.start();
            cibRec.load();
            
            shell.open();
            cibRec.grabFocus();
            
            while (!shell.isDisposed()) {
                  if (!display.readAndDispatch())
                        display.sleep();
            }
            display.dispose();
      }
}