io.guise.framework.component.AbstractContainer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
/*
* Copyright © 2005-2008 GlobalMentor, Inc.
* This implementation delegates to {@link #add(int, Component)}.
*
*/
@Override
public Component add(final int index, final Prototype prototype) {
final Component component = createComponent(prototype); //create a component from the prototype
add(index, component); //add the component to the container
return component; //return the component we created
}
/**
* {@inheritDoc}
*
* This implementation delegates to {@link #add(Component)}.
*
*/
@Override
public Component add(final Prototype prototype) {
final Component component = createComponent(prototype); //create a component from the prototype
add(component); //add the component to the container
return component; //return the component we created
}
/**
* {@inheritDoc}
*
* This implementation delegates to {@link #add(int, Component, Constraints)}.
*
*/
@Override
public Component add(final int index, final Prototype prototype, final Constraints constraints) {
final Component component = createComponent(prototype); //create a component from the prototype
add(index, component, constraints); //add the component to the container
return component; //return the component we created
}
/**
* {@inheritDoc}
*
* This implementation delegates to {@link #add(Component, Constraints)}.
*
*/
@Override
public Component add(final Prototype prototype, final Constraints constraints) {
final Component component = createComponent(prototype); //create a component from the prototype
add(component, constraints); //add the component to the container
return component; //return the component we created
}
/**
* Creates a component appropriate for the context of this component from the given prototype. This version creates the following components, in order of
* priority:
*
* - {@link ActionPrototype}
* - {@link Button}
* - {@link LabelPrototype}
* - {@link Label}
* - {@link MenuPrototype}
* - {@link DropMenu}
* - {@link TogglePrototype}
* - {@link BooleanSelectButton}
* - {@link ValuePrototype}<{@link Boolean}>
* - {@link CheckControl}
* - {@link ValuePrototype}<{@link Number}> with installed {@link RangeValidator}
* - {@link SliderControl}
* - {@link ValuePrototype}<?>
* - {@link TextControl}
*
* @param prototype The prototype of the component to create.
* @return A new component based upon the given prototype.
* @throws IllegalArgumentException if no component can be created from the given prototype
*/
public Component createComponent(final Prototype prototype) {
if(prototype instanceof MenuPrototype) { //menu prototypes
return new DropMenu((MenuPrototype)prototype, Flow.PAGE);
} else if(prototype instanceof ActionPrototype) { //all other action prototypes
return new Button((ActionPrototype)prototype);
} else if(prototype instanceof LabelPrototype) { //label prototypes
return new Label((LabelPrototype)prototype);
} else if(prototype instanceof TogglePrototype) { //toggle prototypes
final TogglePrototype togglePrototype = (TogglePrototype)prototype; //get the toggle prototype
final BooleanSelectButton booleanSelectButton = new BooleanSelectButton(togglePrototype); //create a boolean select button
booleanSelectButton.setToggle(true); //turn on toggling
return booleanSelectButton; //return the button
} else if(prototype instanceof ValuePrototype) { //value prototypes
final ValuePrototype valuePrototype = (ValuePrototype)prototype; //get the value prototype
final Class valueClass = valuePrototype.getValueClass(); //get the type of value represented
if(Boolean.class.isAssignableFrom(valueClass)) { //if a boolean value is represented
return new CheckControl((ValuePrototype)prototype);
} else if(Number.class.isAssignableFrom(valueClass) && valuePrototype.getValidator() instanceof RangeValidator) { //if a number range is represented
return new SliderControl((ValuePrototype)prototype, Flow.LINE);
} else { //if the prototype is unrecognized
throw new IllegalArgumentException("Unrecognized prototype: " + prototype.getClass());
}
/*TODO finish
else { //for any other value type
return new TextControl()
}
*/
} else { //if the prototype is unrecognized
throw new IllegalArgumentException("Unrecognized prototype: " + prototype.getClass());
}
}
/*
* Creates a component appropriate for the context of this component from the given prototype. This implementation creates the following components, in order
* of priority:
*
* - {@link ActionPrototype}
* - {@link Button}
* - {@link LabelPrototype}
* - {@link Label}
* - {@link MenuPrototype}
* - {@link DropMenu}
* - {@link ValuePrototype}<{@link Boolean}>
* - {@link CheckControl}
* - {@link ValuePrototype}<?>
* - {@link TextControl}
*
* @param prototype The prototype of the component to create.
* @return A new component based upon the given prototype.
* @throws IllegalArgumentException if no component can be created from the given prototype
*/
/*TODO del if not needed
public ValueControl createValueControl(final ValuePrototype valuePrototype)
{
final Class valueClass=valuePrototype.getValueClass(); //get the type of value represented
if(Boolean.class.isAssignableFrom(valueClass)) { //if a boolean value is represented
return new CheckControl((ValuePrototype)valuePrototype);
}
else { //for any other value type
return new TextControl()
}
}
*/
@Override
public boolean remove(final Object componentObject) {
final Component component = (Component)componentObject; //cast the object to a component
final int index = indexOf(component); //get the index of the component
removeComponent(component); //remove the component normally
assert index >= 0 : "Component successfully removed from container, yet previous index is negative.";
return true; //removing a component from a container will always result in container modification
}
@Override
public Component remove(final int index) {
final Component component = get(index); //get the component at this index
remove(component); //remove the component
return component; //return the component that was removed
}
@Override
public void clear() {
for(final Component component : this) { //for each component in the container
remove(component); //remove this component
}
}
@Override
public Iterator iterator() {
return getComponentList().iterator();
}
@Override
public List getChildComponents() {
return new ArrayList(getComponentList()); //create and return a copy of the list
}
/**
* Sets the children in this container. This method along with {@link #getChildComponents()} provides a children property for alternate children
* access.
* @param children The new children for this container in order.
* @see #clear()
* @see #add(Component)
*/
public void setChildren(final List children) {
clear(); //remove all children from the container
for(final Component child : children) { //for each child
add(child); //add this child
}
}
@Override
public void setLayout(final Layout newLayout) {
super.setLayout(newLayout); //delegate to the parent class
}
/**
* Layout constructor with a default info model.
* @param layout The layout definition for the container.
* @throws NullPointerException if the given layout is null.
*/
public AbstractContainer(final Layout layout) {
this(new DefaultInfoModel(), layout); //construct the class with a default info model
}
/**
* Info model and layout constructor.
* @param infoModel The component info model.
* @param layout The layout definition for the container.
* @throws NullPointerException if the given info model and/or layout is null.
*/
public AbstractContainer(final InfoModel infoModel, final Layout layout) {
super(infoModel, layout); //construct the parent class
}
}