/*******************************************************************************
* Copyright (c) 2008 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.ui.internal.util;
import java.util.Collection;
import java.util.Iterator;
import org.eclipse.jpt.ui.internal.widgets.Pane;
import org.eclipse.jpt.utility.internal.CollectionTools;
import org.eclipse.jpt.utility.internal.iterators.TransformationIterator;
import org.eclipse.jpt.utility.model.value.PropertyValueModel;
/**
* This <code>PaneVisibilityEnabler</code> keeps the "visible" state of a
* collection of controls in synch with the provided boolean holder.
*
* @version 2.0
* @since 2.0
*/
public class PaneVisibilityEnabler extends StateController
{
/**
* Creates a new <code>PaneVisibilityEnabler</code> with a default value of
* <code>false</code> (i.e. not visible).
*
* @param booleanHolder A value model on the underlying boolean model
* @param pane The pane whose "visible" state is kept in sync with the
* boolean holder's value
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Pane<?> pane) {
this(booleanHolder, pane, false);
}
/**
* Creates a new <code>PaneVisibilityEnabler</code> with a default value of
* <code>false</code> (i.e. not visible).
*
* @param booleanHolder A value model on the underlying boolean model
* @param panes The collection of panes whose "visible" state is kept in sync
* with the boolean holder's value
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Pane<?>... panes) {
this(booleanHolder, CollectionTools.collection(panes), false);
}
/**
* Creates a new <code>PaneVisibilityEnabler</code>.
*
* @param booleanHolder A value model on the underlying boolean model
* @param pane The pane whose "visible" state is kept in sync with the
* boolean holder's value
* @param defaultValue The value to use when the underlying model is
* <code>null</code>
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Pane<?> pane,
boolean defaultValue) {
this(booleanHolder, CollectionTools.singletonIterator(pane), false);
}
/**
* Creates a new <code>PaneVisibilityEnabler</code>.
*
* @param booleanHolder A value model on the underlying boolean model
* @param panes The collection of panes whose "visible" state is kept in sync
* with the boolean holder's value
* @param defaultValue The value to use when the underlying model is
* <code>null</code>
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Pane<?>[] panes,
boolean defaultValue) {
this(booleanHolder, CollectionTools.iterator(panes), defaultValue);
}
/**
* Creates a new <code>PaneVisibilityEnabler</code> with a default value of
* <code>false</code> (i.e. not visible).
*
* @param booleanHolder A value model on the underlying boolean model
* @param panes The collection of panes whose "visible" state is kept in sync
* with the boolean holder's value
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Collection<? extends Pane<?>> panes) {
this(booleanHolder, panes, false);
}
/**
* Creates a new <code>PaneVisibilityEnabler</code>.
*
* @param booleanHolder A value model on the underlying boolean model
* @param panes The collection of panes whose "visible" state is kept in sync
* with the boolean holder's value
* @param defaultValue The value to use when the underlying model is
* <code>null</code>
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Collection<? extends Pane<?>> panes,
boolean defaultValue) {
this(booleanHolder, panes.iterator(), defaultValue);
}
/**
* Creates a new <code>PaneVisibilityEnabler</code> with a default value of
* <code>false</code> (i.e. not visible).
*
* @param booleanHolder A value model on the underlying boolean model
* @param panes An iterator on the collection of panes whose "visible" state
* is kept in sync with the boolean holder's value
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Iterator<? extends Pane<?>> panes) {
this(booleanHolder, panes, false);
}
/**
* Creates a new <code>PaneVisibilityEnabler</code>.
*
* @param booleanHolder A value model on the underlying boolean model
* @param panes An iterator on the collection of panes whose "visible" state
* is kept in sync with the boolean holder's value
* @param defaultValue The value to use when the underlying model is
* <code>null</code>
*/
public PaneVisibilityEnabler(PropertyValueModel<Boolean> booleanHolder,
Iterator<? extends Pane<?>> panes,
boolean defaultValue) {
super(booleanHolder, wrap(panes), defaultValue);
}
private static Collection<ControlHolder> wrap(Iterator<? extends Pane<?>> panes) {
return CollectionTools.collection(new TransformationIterator<Pane<?>, ControlHolder>(panes) {
@Override
protected ControlHolder transform(Pane<?> pane) {
return new PaneHolder(pane);
}
});
}
/**
* This holder holds onto an <code>Pane</code> and update its visible
* state.
*/
private static class PaneHolder implements ControlHolder {
private final Pane<?> pane;
PaneHolder(Pane<?> pane) {
super();
this.pane = pane;
}
public void updateState(boolean state) {
this.pane.setVisible(state);
}
}
}
