com.izforge.izpack.installer.gui.IzPanels Maven / Gradle / Ivy
/*
* IzPack - Copyright 2001-2012 Julien Ponge, All Rights Reserved.
*
* http://izpack.org/
* http://izpack.codehaus.org/
*
* Copyright 2012 Tim Anderson
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.izforge.izpack.installer.gui;
import com.izforge.izpack.api.container.Container;
import com.izforge.izpack.installer.data.GUIInstallData;
import com.izforge.izpack.installer.panel.AbstractPanels;
import java.util.List;
/**
* Implementation of {@link AbstractPanels} for {@link IzPanel}.
*
* @author Tim Anderson
*/
public class IzPanels extends AbstractPanels
{
/**
* The installation data.
*/
private final GUIInstallData installData;
/**
* The container to add {@link IzPanel}s to.
*/
private final Container container;
/**
* The listener to notify of events.
*/
private IzPanelsListener listener;
/**
* Determines if the current panel switch is navigating backwards or forwards.
*/
private boolean isBack = false;
/**
* Constructs a {@code IzPanels}.
*
* @param panels the panels
* @param container the container to register {@link IzPanel}s with
* @param installData the installation data
*/
public IzPanels(List panels, Container container, GUIInstallData installData)
{
super(panels, installData);
this.container = container;
this.installData = installData;
}
/**
* Initialises the {@link IzPanel} instances.
*/
public void initialise()
{
for (IzPanelView panel : getPanelViews())
{
// need to defer creation of the IzPanel until after the InstallerFrame is constructed
IzPanel view = panel.getView();
installData.getPanels().add(view);
String panelId = panel.getPanelId();
if (panelId == null)
{
panelId = view.getClass().getName();
}
container.addComponent(panelId, view);
}
}
/**
* Sets the listener to notify of events.
*
* @param listener the listener. May be {@code null}
*/
public void setListener(IzPanelsListener listener)
{
this.listener = listener;
}
/**
* Determines if the current panel switch is navigating backwards or forwards.
*
* @return {@code true} if the current panel switch is navigating backwards, {@code false} if navigating forwards
* or no panel switch is in progress
*/
public boolean isBack()
{
return isBack;
}
/**
* Switches panels.
*
* @param newPanel the panel to switch to
* @param oldPanel the panel to switch from, or {@code null} if there was no prior panel
* @return {@code true} if the switch was successful
*/
@Override
protected boolean switchPanel(IzPanelView newPanel, IzPanelView oldPanel)
{
boolean result = false;
try
{
isBack = oldPanel != null && newPanel.getIndex() < oldPanel.getIndex();
if (listener != null)
{
listener.switchPanel(newPanel, oldPanel);
result = true;
}
}
finally
{
isBack = false;
}
return result;
}
}