Package: PropertyBinder

PropertyBinder

name	instruction	branch	complexity	line	method
static {...}	M: 0 C: 3 100%	M: 0 C: 0 100%	M: 0 C: 1 100%	M: 0 C: 1 100%	M: 0 C: 1 100%

Coverage

1: /*
2: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone git@bitbucket.org:tidalwave/northernwind-rca-src.git
7: * %%
8: * Copyright (C) 2013 - 2021 Tidalwave s.a.s. (http://tidalwave.it)
9: * %%
10: * *********************************************************************************************************************
11: *
12: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
13: * the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
18: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
19: * specific language governing permissions and limitations under the License.
20: *
21: * *********************************************************************************************************************
22: *
23: *
24: * *********************************************************************************************************************
25: * #L%
26: */
27: package it.tidalwave.northernwind.rca.ui.contenteditor.spi;
28:
29: import javax.annotation.Nonnull;
30: import it.tidalwave.util.Key;
31: import it.tidalwave.role.ui.BoundProperty;
32: import it.tidalwave.northernwind.core.model.ResourceProperties;
33: import it.tidalwave.northernwind.rca.embeddedserver.EmbeddedServer.Document;
34:
35: /***********************************************************************************************************************
36: *
37: * A role that allows to bind items of {@link ResourceProperties} to other objects, typically for managing a User
38: * Interface.
39: *
40: * @stereotype role
41: *
42: * @author Fabrizio Giudici
43: *
44: **********************************************************************************************************************/
45: public interface PropertyBinder
46: {
47: public static final Class<PropertyBinder> _PropertyBinder_ = PropertyBinder.class;
48:
49: /*******************************************************************************************************************
50: *
51: * A callback that notifies when an item has been updated. Any change to bound objects will cause the creation of
52: * a new instance of {@link ResourceProperties} with the updated values, notified through this callback.
53: *
54: ******************************************************************************************************************/
55: @FunctionalInterface
56: public static interface UpdateCallback
57: {
58: public void notify (@Nonnull ResourceProperties properties);
59: }
60:
61: /*******************************************************************************************************************
62: *
63: * Binds a given property to a {@link BoundProperty}. This is useful for any kind of property types, with the
64: * exception of HTML documents.
65: *
66: * @param propertyName the property name in {@link ResourceProperties}
67: * @param boundProperty the object to bind
68: * @param callback the callback that will notify updates
69: *
70: ******************************************************************************************************************/
71: public <T> void bind (@Nonnull Key<T> propertyName,
72: @Nonnull BoundProperty<T> boundProperty,
73: @Nonnull UpdateCallback callback);
74:
75: /*******************************************************************************************************************
76: *
77: * Creates a Document bound to the given property. This is useful for HTML documents, since they undergo a special
78: * processing for being edited in a HTML viewer (CSS and JavaScript resources are inserted in the head).
79: *
80: * FIXME: I don't like the asymmetry with bind(), that accepts a BoundProperty. This is due to the fact that
81: * BoundProperty is mutable, while Document is immutable. Actually, a mutable Document would be acceptable.
82: *
83: * @param propertyName the property name in {@link ResourceProperties}
84: * @param callback the callback that will notify updates
85: * @return the bound document
86: *
87: ******************************************************************************************************************/
88: @Nonnull
89: public Document createBoundDocument (@Nonnull Key<String> propertyName,
90: @Nonnull UpdateCallback callback);
91: }