Method: ofMaybePresentable(As)

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * SteelBlue: DCI User Interfaces
5: * http://tidalwave.it/projects/steelblue
6: *
7: * Copyright (C) 2015 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *************************************************************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * 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
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/steelblue-src
22: * git clone https://github.com/tidalwave-it/steelblue-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.ui.core.role;
27:
28: import jakarta.annotation.Nonnull;
29: import java.util.Collection;
30: import java.util.Collections;
31: import it.tidalwave.util.As;
32: import it.tidalwave.util.NamedCallback;
33: import it.tidalwave.util.Parameters;
34: import it.tidalwave.role.SimpleComposite;
35: import it.tidalwave.ui.core.Mutable;
36: import it.tidalwave.ui.core.role.impl.DefaultPresentationModel;
37: import org.apiguardian.api.API;
38: import static it.tidalwave.util.Parameters.r;
39: import static it.tidalwave.ui.core.role.Presentable._Presentable_;
40: import static org.apiguardian.api.API.Status.EXPERIMENTAL;
41:
42: /***************************************************************************************************************************************************************
43: *
44: * TODO: As the NetBeans Node, it should allow children, have event listeners for children added/removed/changed.
45: * This class so becomes the true M in MVC.
46: *
47: * @stereotype Role
48: * @since 2.0-ALPHA-1
49: * @author Fabrizio Giudici
50: *
51: **************************************************************************************************************************************************************/
52: public interface PresentationModel extends As, Mutable
53: {
54: public static final Class<PresentationModel> _PresentationModel_ = PresentationModel.class;
55:
56: public static final As.Type<SimpleComposite<PresentationModel>> _SimpleCompositeOfPresentationModel_ = As.type(SimpleComposite.class);
57:
58: public static final String PROPERTY_CHILDREN = "children";
59:
60: /** This is an undocumented feature. If you add a {@link NamedCallback} with this name as a role in this object, it will be called back when
61: {@link #dispose()} is called. */
62: public static final String CALLBACK_DISPOSE = "dispose";
63:
64: public static final String P_VERBOSE_TOSTRING = PresentationModel.class.getCanonicalName() + ".verboseToString";
65:
66: public static final String PARAM_OWNER = "owner";
67: public static final String PARAM_ROLE = "role";
68:
69: /***********************************************************************************************************************************************************
70: * Disposes this object.
71: **********************************************************************************************************************************************************/
72: public void dispose();
73:
74: /***********************************************************************************************************************************************************
75: * {@return a new instance given an owner and no roles}.
76: * @param owner the owner
77: * @since 3.2-ALPHA-3
78: **********************************************************************************************************************************************************/
79: @Nonnull
80: public static PresentationModel of (@Nonnull final Object owner)
81: {
82: Parameters.mustNotBeArrayOrCollection(owner, PARAM_OWNER);
83: return of(owner, Collections.emptyList());
84: }
85:
86: /***********************************************************************************************************************************************************
87: * {@return a new instance given an owner and a single role}.
88: * @param owner the owner
89: * @param role the role (or a {@link it.tidalwave.util.RoleFactory})
90: * @since 3.2-ALPHA-3
91: **********************************************************************************************************************************************************/
92: @Nonnull
93: public static PresentationModel of (@Nonnull final Object owner, @Nonnull final Object role)
94: {
95: Parameters.mustNotBeArrayOrCollection(owner, PARAM_OWNER);
96: Parameters.mustNotBeArrayOrCollection(role, PARAM_ROLE);
97: return of(owner, r(role));
98: }
99:
100: /***********************************************************************************************************************************************************
101: * {@return a new instance given an owner and multiple roles}.
102: * @param owner the owner
103: * @param roles roles or {@link it.tidalwave.util.RoleFactory} instances
104: * @since 3.2-ALPHA-1
105: * @since 3.2-ALPHA-3 (refactored)
106: **********************************************************************************************************************************************************/
107: @Nonnull
108: public static PresentationModel of (@Nonnull final Object owner, @Nonnull final Collection<Object> roles)
109: {
110: Parameters.mustNotBeArrayOrCollection(owner, PARAM_OWNER);
111: return new DefaultPresentationModel(owner, roles);
112: }
113:
114: /***********************************************************************************************************************************************************
115: * {@return an empty instance (no roles, with the exception of a dummy {@link Displayable})}.
116: * @since 3.2-ALPHA-3
117: **********************************************************************************************************************************************************/
118: @Nonnull
119: public static PresentationModel empty()
120: {
121: // TODO: cache a singleton, but don't do eager initialization (e.g. a final static), as it would deadlock
122: return of("", Displayable.of("<empty presentation model>"));
123: }
124:
125: /***********************************************************************************************************************************************************
126: * {@return a new instance from an owner which might have the {@link Presentable} role}. If it is present, it is called to create the
127: * {@code PresentationModel}; otherwise a default one is created. Additional roles are added.
128: * @param owner the owner
129: * @param roles roles or {@link it.tidalwave.util.RoleFactory} instances
130: * @since 3.2-ALPHA-8
131: **********************************************************************************************************************************************************/
132: @API(status = EXPERIMENTAL) // TODO: perhaps it could be merged to of().
133: @Nonnull
134: public static PresentationModel ofMaybePresentable (@Nonnull final As owner, @Nonnull final Collection<Object> roles)
135: {
136: Parameters.mustNotBeArrayOrCollection(owner, PARAM_OWNER);
137: return owner.maybeAs(_Presentable_)
138: .map(p -> p.createPresentationModel(roles))
139: .orElseGet(() -> of(owner, roles));
140: }
141:
142: /***********************************************************************************************************************************************************
143: * {@return a new instance from an owner which might have the {@link Presentable} role}. If it is present, it is called to create the
144: * {@code PresentationModel}; otherwise a default one is created.
145: * @param owner the owner
146: * @since 3.2-ALPHA-8
147: **********************************************************************************************************************************************************/
148: @API(status = EXPERIMENTAL) // TODO: perhaps it could be merged to of().
149: @Nonnull
150: public static PresentationModel ofMaybePresentable (@Nonnull final As owner)
151: {
152: return ofMaybePresentable(owner, Collections.emptyList());
153: }
154:
155: /***********************************************************************************************************************************************************
156: * Sets the verbose mode for {@link java.lang.Object#toString} implementations of {@code PresentationModel}. Looking at the implementation of
157: * {@link javafx.scene.control.cell.DefaultTreeCell}, the code always calls {@code toString()} during an update, even though the text value is later
158: * overridden; hence, this method should be as fast as possible. By default, the shortened class name and system id of the owner object is returned;
159: * set verbosity to have the owner object {@code toString()} called instead.
160: * It is also possible to set system the property {@code it.tidalwave.ui.core.role.PresentationModel.verboseToString}.
161: * @param verbose the verbosity
162: * @since 2.0-ALPHA-4
163: * @see #isVerboseToString()
164: **********************************************************************************************************************************************************/
165: public static void setVerboseToString (final boolean verbose)
166: {
167: DefaultPresentationModel.setVerboseToString(verbose);
168: }
169:
170: /***********************************************************************************************************************************************************
171: * {@return the verbose mode for {@link java.lang.Object#toString} implementations of {@code PresentationModel}}.
172: * @since 2.0-ALPHA-4
173: * @see #setVerboseToString(boolean)
174: **********************************************************************************************************************************************************/
175: public static boolean isVerboseToString()
176: {
177: return DefaultPresentationModel.isVerboseToString();
178: }
179: }