Package: GalleryAdapter

GalleryAdapter

Coverage

1: /*
2: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone https://bitbucket.org/tidalwave/northernwind-src.git
7: * %%
8: * Copyright (C) 2011 - 2023 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.frontend.ui.component.gallery.spi;
28:
29: import javax.annotation.Nonnull;
30: import java.util.List;
31: import it.tidalwave.util.Id;
32: import it.tidalwave.northernwind.core.model.ResourceProperties;
33: import it.tidalwave.northernwind.frontend.ui.RenderContext;
34: import it.tidalwave.northernwind.frontend.ui.component.gallery.GalleryViewController.GalleryItem;
35:
36: /***********************************************************************************************************************
37: *
38: * @author Fabrizio Giudici
39: *
40: **********************************************************************************************************************/
41: public interface GalleryAdapter
42: {
43: /*******************************************************************************************************************
44: *
45: *
46: *
47: ******************************************************************************************************************/
48: @Nonnull
49: public ResourceProperties getExtraViewProperties (@Nonnull Id viewId);
50:
51: /*******************************************************************************************************************
52: *
53: *
54: *
55: ******************************************************************************************************************/
56: @Nonnull
57: public String getInlinedScript();
58:
59: /*******************************************************************************************************************
60: *
61: * Prepares a catalog of media items to be consumed by the gallery client software.
62: *
63: * @param items the list of gallery items
64: *
65: ******************************************************************************************************************/
66: public void prepareCatalog (@Nonnull List<? extends GalleryItem> items);
67:
68: /*******************************************************************************************************************
69: *
70: * Prepares the full JS page.
71: *
72: * @param item the gallery item
73: * @param items the list of gallery items
74: *
75: ******************************************************************************************************************/
76: public void prepareGallery (@Nonnull GalleryItem item, @Nonnull List<? extends GalleryItem> items);
77:
78: /*******************************************************************************************************************
79: *
80: * Prepares the fallback page.
81: *
82: * @param item the gallery item
83: * @param items the list of gallery items
84: *
85: ******************************************************************************************************************/
86: public void prepareFallbackGallery (@Nonnull GalleryItem item, @Nonnull List<? extends GalleryItem> items);
87:
88: /*******************************************************************************************************************
89: *
90: * Prepares the fallback lightbox.
91: *
92: * @param items the list of gallery items
93: *
94: ******************************************************************************************************************/
95: public void prepareFallbackLightbox (@Nonnull List<? extends GalleryItem> items);
96:
97: /*******************************************************************************************************************
98: *
99: * Renders what has been previously prepared.
100: *
101: ******************************************************************************************************************/
102: public void render (@Nonnull RenderContext context);
103: }