PortletHelpWindow.java

/*
 * RHQ Management Platform
 * Copyright (C) 2005-2008 Red Hat, Inc.
 * All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2, as
 * published by the Free Software Foundation, and/or the GNU Lesser
 * General Public License, version 2.1, also as published by the Free
 * Software Foundation.
 *
 * 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 and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with this program;
 * if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

package org.rhq.coregui.client.dashboard;

import com.smartgwt.client.types.LayoutPolicy;
import com.smartgwt.client.types.Overflow;
import com.smartgwt.client.widgets.Canvas;
import com.smartgwt.client.widgets.Label;
import com.smartgwt.client.widgets.Window;
import com.smartgwt.client.widgets.layout.VLayout;

import org.rhq.core.domain.dashboard.DashboardPortlet;
import org.rhq.coregui.client.CoreGUI;
import org.rhq.coregui.client.Messages;

/**
 * This is a window for displaying portlet settings. The window contains a form which in turn will contain the
 * widgets for a portlet's settings. Those widgets will have to be passed to the window since the window is intended
 * to support all portlets. The layout and sizing strategy for this window is to be as large as the widgets contained
 * within it. And the form will stretch and resize as the window is resized. This flexible layout strategy is used
 * since there are different settings (with different widgets) for different portlets which will in turn result in
 * different sizes for the parent window.
 *
 * @author John Sanda
 */
public class PortletHelpWindow extends Window {
    private static Messages MSG = CoreGUI.getMessages();
    @SuppressWarnings("unused")
    private DashboardPortlet storedPortlet;
    private Portlet view;

    public PortletHelpWindow(DashboardPortlet storedPortlet, Portlet view) {
        this.storedPortlet = storedPortlet;
        this.view = view;

        setTitle(storedPortlet.getName() + " " + MSG.common_title_help());
        setOverflow(Overflow.VISIBLE);
        //        setAutoSize(true);

        setHeight(400);
        setWidth(400);
        setAutoCenter(true);
        setCanDragResize(true);
        setCanDragReposition(true);
        setDismissOnEscape(true);
        setDismissOnOutsideClick(true);
    }

    @Override
    protected void onInit() {
        super.onInit();

        Canvas c = view.getHelpCanvas();

        VLayout layout = new VLayout();
        layout.setWidth100();
        layout.setHeight100();
        layout.setPadding(15);
        layout.setLayoutMargin(20);
        layout.setVPolicy(LayoutPolicy.FILL);

        if (c != null) {
            layout.addMember(c);
        } else {
            layout.addMember(new Label(MSG.view_portlet_help_none()));
        }

        addItem(layout);
    }
}