NavigationItem.java

/*
 * RHQ Management Platform
 * Copyright 2010, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * 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 version 2 of the License.
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.rhq.coregui.client.components.view;


/**
 * @author Ian Springer
 */
public class NavigationItem {
    private final ViewName viewName;
    private final String icon;
    private final ViewFactory viewFactory;
    private final boolean enabled;

    private boolean refreshRequired = false;


    public NavigationItem(ViewName name,  ViewFactory viewFactory) {
        this(name, name.getIcon().getIcon16x16Path(), viewFactory, true);
    }

    @Deprecated
    public NavigationItem(ViewName name, String icon, ViewFactory viewFactory) {
        this(name, icon, viewFactory, true);
    }

    public NavigationItem(ViewName name,  ViewFactory viewFactory, boolean enabled) {
        this.icon = name.getIcon().getIcon16x16Path();
        this.viewName = name;
        this.viewFactory = viewFactory;
        this.enabled = enabled;
    }

    @Deprecated
    public NavigationItem(ViewName name, String icon, ViewFactory viewFactory, boolean enabled) {
        this.icon = icon;
        this.viewName = name;
        this.viewFactory = viewFactory;
        this.enabled = enabled;
    }

    public ViewName getViewName() {
        return viewName;
    }

    public String getName() {
        return viewName.getName();
    }

    public String getTitle() {
        return viewName.getTitle();
    }

    public String getIcon() {
        return icon;
    }

    public ViewFactory getViewFactory() {
        return viewFactory;
    }

    public boolean isEnabled() {
        return enabled;
    }

    /**
     * This flag indicates if the item's view must be refreshed when its main navigation item
     * is selected within the user interface. Most times, if the navigation item's view is already
     * created, it can just be re-displayed as it was previously - in which case this flag can
     * be <code>false</code> (which is its default). However, if the view must be recreated due to
     * the possibility of some dynamic data changing (where that dynamic data is needed to build 
     * the view), then this flag should be <code>true</code>.
     * 
     * @return flag to indicate if the navigation item's view needs to be refreshed when the item is selected again 
     */
    public boolean isRefreshRequired() {
        return refreshRequired;
    }

    public void setRefreshRequired(boolean flag) {
        this.refreshRequired = flag;
    }
}