Package: AudioExplorerPresentation$Properties

AudioExplorerPresentation$Properties

name	instruction	branch	complexity	line	method
AudioExplorerPresentation.Properties()	M: 9 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 2 C: 0 0%	M: 1 C: 0 0%
folderNameProperty()	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * blueMarine II: Semantic Media Centre
5: * http://tidalwave.it/projects/bluemarine2
6: *
7: * Copyright (C) 2015 - 2021 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
12: * the License. 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
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/bluemarine2-src
23: * git clone https://github.com/tidalwave-it/bluemarine2-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.bluemarine2.ui.audio.explorer;
28:
29: import javax.annotation.Nonnull;
30: import java.util.Optional;
31: import java.net.URI;
32: import javafx.beans.property.SimpleStringProperty;
33: import javafx.beans.property.StringProperty;
34: import it.tidalwave.role.ui.PresentationModel;
35: import it.tidalwave.role.ui.UserAction;
36: import it.tidalwave.bluemarine2.model.spi.Entity;
37: import lombok.Getter;
38: import lombok.experimental.Accessors;
39:
40: /***********************************************************************************************************************
41: *
42: * The Presentation of the explorer of audio media files.
43: *
44: * @stereotype Presentation
45: *
46: * @author Fabrizio Giudici
47: *
48: **********************************************************************************************************************/
49: public interface AudioExplorerPresentation
50: {
51: @Getter @Accessors(fluent = true)
52: public static class Properties
53: {
54: private final StringProperty folderNameProperty = new SimpleStringProperty("");
55: }
56:
57: /*******************************************************************************************************************
58: *
59: * Binds the UI with the callbacks.
60: *
61: * @param upAction the action to go to the upper folder
62: *
63: ******************************************************************************************************************/
64: public void bind (@Nonnull Properties properties, @Nonnull UserAction upAction);
65:
66: /*******************************************************************************************************************
67: *
68: * Shows this presentation on the screen.
69: *
70: ******************************************************************************************************************/
71: public void showUp (@Nonnull Object control);
72:
73: /*******************************************************************************************************************
74: *
75: * Populates the presentation with the available media browsers.
76: *
77: * @param pm the {@link PresentationModel}
78: *
79: ******************************************************************************************************************/
80: public void populateBrowsers (@Nonnull PresentationModel pm);
81:
82: /*******************************************************************************************************************
83: *
84: * Populates the presentation with a set of items and optionally restores some visual properties.
85: *
86: * @param pm the {@link PresentationModel}
87: * @param optionalMemento the container of properties
88: *
89: ******************************************************************************************************************/
90: public void populateItems (@Nonnull PresentationModel pm, @Nonnull Optional<Object> optionalMemento);
91:
92: /*******************************************************************************************************************
93: *
94: * Renders some details about an {@link Entity}.
95: *
96: * @param entityDetails the details
97: *
98: ******************************************************************************************************************/
99: public void renderDetails (@Nonnull String entityDetails);
100:
101: /*******************************************************************************************************************
102: *
103: * Puts the focus on the list to select media items.
104: *
105: ******************************************************************************************************************/
106: public void focusOnMediaItems();
107:
108: /*******************************************************************************************************************
109: *
110: * Returns an object containing the snapshot of some relevant visual properties.
111: *
112: * @return the memento object
113: *
114: ******************************************************************************************************************/
115: @Nonnull
116: public Object getMemento();
117:
118: /*******************************************************************************************************************
119: *
120: *
121: ******************************************************************************************************************/
122: public void setCoverArt (@Nonnull Optional<URI> optionalCoverArtUri);
123: }