Project

General

Profile

« Previous | Next » 

Revision c226920a

Added by Fabian Reimeier almost 6 years ago

Documentation and refactoring

View differences:

src/main/java/eu/etaxonomy/cdm/vaadin/component/distributionStatus/HelpWindow.java
25 25
import eu.etaxonomy.cdm.vaadin.view.distributionStatus.IDistributionTableView;
26 26

  
27 27
/**
28
 * A help window to display useful information on the usage of the distribution editor.
28 29
 * @author freimeier
29 30
 * @since 9 Mar 2018
30 31
 *
......
34 35
    private AbstractOrderedLayout mainLayout;
35 36
    private IDistributionTableView view;
36 37

  
38
    /**
39
     * Creates a new help window.
40
     * @param view The view the help window is related to.
41
     */
37 42
    public HelpWindow(IDistributionTableView view) {
38 43
        this.view = view;
39 44
        buildMainLayout();
40 45
    }
41 46

  
47
    /**
48
     * Builds the layout of the help window and populates it with content.
49
     * @return Layout of the help window.
50
     */
42 51
    private AbstractLayout buildMainLayout() {
43 52
        mainLayout = new VerticalLayout();
44 53
        mainLayout.setSizeFull();
......
59 68
        return mainLayout;
60 69
    }
61 70

  
71
    /**
72
     * Creates the help window to display.
73
     * @param caption The caption of the window.
74
     * @return Help window to be displayed.
75
     */
62 76
    public Window createWindow(String caption) {
63 77
        window = new Window();
64 78
        window.setModal(true);

Also available in: Unified diff