File: DefaultWindowWrapper.java

package info (click to toggle)
libgrinvin-core-java 1.2-1
  • links: PTS, VCS
  • area: contrib
  • in suites: squeeze
  • size: 3,904 kB
  • ctags: 5,009
  • sloc: java: 23,494; xml: 423; makefile: 15
file content (138 lines) | stat: -rw-r--r-- 5,033 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/* DefaultWindowWrapper.java
 * =========================================================================
 * This file is part of the GrInvIn project - http://www.grinvin.org
 * 
 * Copyright (C) 2005-2008 Universiteit Gent
 * 
 * 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 2 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.
 * 
 * A copy of the GNU General Public License can be found in the file
 * LICENSE.txt provided with the source distribution of this program (see
 * the META-INF directory in the source jar). This license can also be
 * found on the GNU website at http://www.gnu.org/licenses/gpl.html.
 * 
 * If you did not receive a copy of the GNU General Public License along
 * with this program, contact the lead developer, or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

package org.grinvin.workspace;

import java.awt.Rectangle;
import java.awt.Window;
import java.io.IOException;

import org.grinvin.io.IOFormatException;
import org.grinvin.io.SectionLoader;
import org.grinvin.io.SectionSaver;

import org.jdom.DataConversionException;
import org.jdom.Element;

/**
 * Common super class of all wrappers that manage a single window of
 * type <tt>W</tt>.
 */
public abstract class DefaultWindowWrapper<W extends Window> implements Wrapper<W> {
    
    /**
     * {@inheritDoc}<p>
     * This implementation disposes of the associated window.
     */
    public void dispose(W window) {
        window.dispose();
    }
    
    //
    public abstract W create();
    
    /**
     * General purpose routine which can be used to set bounds
     * and visbility of any window.
     */
    protected static void loadWindowProperties(Element element, Window window) throws IOFormatException {
        window.setBounds(elementToBounds(element));
        try {
            window.setVisible(
                    element.getAttribute("isvisible").getBooleanValue() );
        } catch (DataConversionException ex) {
            throw new IOFormatException("Incorrect boolean attribute value", ex);
        }
    }
    
    /**
     * General purpose routine which can be used to save the
     * bounds and visibility of any window.
     */
    protected static void saveWindowProperties(Element element, Window window) {
        Rectangle bounds = window.getBounds();
        element.addContent(boundsToElement(bounds));
        element.setAttribute("isvisible", Boolean.toString(window.isVisible()));
    }
    
    private static Element boundsToElement(Rectangle bounds) {
        Element element = new Element("bounds");
        
        element.setAttribute("x", Integer.toString(bounds.x));
        element.setAttribute("y", Integer.toString(bounds.y));
        
        element.setAttribute("height", Integer.toString(bounds.height));
        element.setAttribute("width", Integer.toString(bounds.width));
        
        return element;
    }
    
    private static Rectangle elementToBounds(Element element) throws IOFormatException {
        Element child = element.getChild("bounds");
        
        if (child == null)
            throw new IOFormatException("expected <bounds> element");
        
        int x = Integer.parseInt(child.getAttributeValue("x"));
        int y = Integer.parseInt(child.getAttributeValue("y"));
        int height = Integer.parseInt(child.getAttributeValue("height"));
        int width = Integer.parseInt(child.getAttributeValue("width"));
        
        return new Rectangle(x, y, width, height);
    }
    
    /**
     * {@inheritDoc}<p>This implementation creates the window using
     * {@link #create} and sets window bounds and visibility
     * from the information in the workspace XML-file.
     */
    public W load(Element element, SectionLoader sloader) throws IOException {
        W window = create();
        loadWindowProperties(element, window);
        return window;
    }
    
    /**
     * Create a JDOM-element that contains the version information.
     * Further attributes and contents should be added later.
     */
    protected final Element baseElement() {
        return new Element(getElementName());
    }
    
    /**
     * {@inheritDoc}<p>This implementation saves the information obtained
     * from the method {@link #baseElement} and {@link #saveWindowProperties} into <tt>parent</tt> and leaves
     * the directory alone.
     */
    public void save(W window, Element parent, SectionSaver ssaver) throws IOException {
        Element result = baseElement();
        saveWindowProperties(result, window);
        parent.addContent(result);
    }
    
}