com.holonplatform.vaadin7.components.PropertyViewGroup Maven / Gradle / Ivy
/*
* Copyright 2016-2017 Axioma srl.
*
* 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.holonplatform.vaadin7.components;
import java.util.Optional;
import java.util.stream.Stream;
import com.holonplatform.core.internal.utils.ObjectUtils;
import com.holonplatform.core.property.Property;
import com.holonplatform.core.property.PropertyBox;
import com.holonplatform.core.property.PropertyRenderer;
import com.holonplatform.vaadin7.components.PropertyBinding.PostProcessor;
import com.holonplatform.vaadin7.internal.components.DefaultPropertyViewGroup;
/**
* Provides functionalities to build and manage a group of {@link ViewComponent}s bound to a {@link Property} set.
*
* @since 5.0.0
*/
public interface PropertyViewGroup extends PropertySetBound, ValueHolder {
/**
* Gets all the {@link ViewComponent}s that have been bound to a property.
* @return An {@link Iterable} on all bound ViewComponents
*/
@SuppressWarnings("rawtypes")
Iterable getViewComponents();
/**
* Get the {@link ViewComponent} bound to given property, if any.
* @param Property type
* @param property Property (not null)
* @return Optional {@link ViewComponent} bound to given property
*/
Optional> getViewComponent(Property property);
/**
* Return a {@link Stream} of the properties and their bound {@link ViewComponent}s of this view group.
* @param Property type
* @return Property-ViewComponent {@link PropertyBinding} stream
*/
Stream>> stream();
/**
* Clears (reset the value) all the {@link ViewComponent}s.
*/
@Override
void clear();
/**
* Get the current property values collected into a {@link PropertyBox}, using the group configured properties as
* property set.
* @return A {@link PropertyBox} containing the property values (never null)
*/
@Override
PropertyBox getValue();
/**
* Set the current property values using a {@link PropertyBox}, loading the values to the available property bound
* {@link ViewComponent}s through the {@link ViewComponent#setValue(Object)} method.
*
* Only the properties which belong to the group's property set are taken into account.
*
* @param propertyBox the {@link PropertyBox} which contains the property values to load. If null, all
* the {@link ViewComponent} components are cleared.
*/
@Override
void setValue(PropertyBox propertyBox);
// ------- Builders
/**
* Get a {@link Builder} to create and setup a {@link PropertyViewGroup}.
* @return {@link PropertyViewGroupBuilder} builder
*/
static PropertyViewGroupBuilder builder() {
return new DefaultPropertyViewGroup.DefaultBuilder();
}
/**
* {@link PropertyViewGroup} builder.
*/
public interface PropertyViewGroupBuilder extends Builder {
}
/**
* Base {@link PropertyViewGroup} builder.
* @param Actual {@link PropertyViewGroup} type
* @param Concrete builder type
*/
public interface Builder> {
/**
* Add given properties to the {@link PropertyViewGroup} property set.
* @param Property type
* @param properties Properties to add
* @return this
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
B properties(P... properties);
/**
* Add given properties to the {@link PropertyViewGroup} property set.
* @param
Property type
* @param properties Properties to add (not null)
* @return this
*/
@SuppressWarnings("rawtypes")
B properties(Iterable
properties);
/**
* Set the given property as hidden. If a property is hidden, the {@link ViewComponent} bound to the property
* will never be generated, but its value will be written to a {@link PropertyBox} using
* {@link PropertyViewGroup#getValue()}.
* @param Property type
* @param property Property to set as hidden (not null)
* @return this
*/
B hidden(Property property);
/**
* Set a specific {@link PropertyRenderer} to use to render the {@link ViewComponent} to bind to given
* property.
* @param Property type
* @param Rendered ViewComponent type
* @param property Property (not null)
* @param renderer Property renderer (not null)
* @return this
*/
B bind(Property property, PropertyRenderer, T> renderer);
/**
* Convenience method to set a specific {@link PropertyRenderer} to use to render the {@link ViewComponent} to
* bind to given property using the {@link ViewComponentPropertyRenderer} functional interface.
* @param Property type
* @param property Property (not null)
* @param renderer Property renderer (not null)
* @return this
*/
B bind(Property property, ViewComponentPropertyRenderer renderer);
/**
* Bind the given property to given viewComponent instance. If the property was
* already bound to a ViewComponent, the old ViewComponent will be replaced by the new ViewComponent.
* @param Property type
* @param property Property (not null)
* @param viewComponent ViewComponent to bind (not null)
* @return this
*/
default B bind(Property property, ViewComponent viewComponent) {
ObjectUtils.argumentNotNull(viewComponent, "ViewComponent must be not null");
return bind(property, p -> viewComponent);
}
/**
* Add a {@link PostProcessor} to allow further {@link ViewComponent} configuration after generation and before
* the ViewComponent is actually bound to a property.
* @param postProcessor the {@link PostProcessor} to add (not null)
* @return this
*/
B withPostProcessor(PostProcessor> postProcessor);
/**
* Set whether to ignore properties without a bound {@link ViewComponent}. Default is false, and an
* exception is thrown if a property of the {@link PropertyViewGroup} cannot be bound to any ViewComponent.
* @param ignoreMissingViewComponents Whether to ignore when the ViewComponent for a property is missing
* @return this
*/
B ignoreMissingViewComponents(boolean ignoreMissingViewComponents);
/**
* Build the {@link PropertyViewGroup}
* @return PropertyViewGroup instance
*/
G build();
}
// -------
/**
* A {@link PropertyRenderer} with a fixed {@link ViewComponent} rendering type.
* @param Property type
*/
@SuppressWarnings("rawtypes")
@FunctionalInterface
public interface ViewComponentPropertyRenderer extends PropertyRenderer {
/*
* (non-Javadoc)
* @see com.holonplatform.core.property.PropertyRenderer#getRenderType()
*/
@Override
default Class getRenderType() {
return ViewComponent.class;
}
}
}