src/com/google/devrel/cluestick/studioclient/Browser.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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.google.devrel.cluestick.studioclient;

import com.appspot.cluestick_server.search.model.Result;

import org.jetbrains.annotations.NotNull;

import javax.swing.JPanel;

/**
 * Browser describes a browser to show a SearchResult inside a built instance
 * of JPanel.
 */
public interface Browser {

  /**
   * Clears a shown result.
   */
  void showEmpty();

  /**
   * Shows the given result in this Browser.
   *
   * @param result to show
   */
  void showResult(@NotNull Result result);

  /**
   * Returns the JPanel to show that contains the empty/shown result content.
   */
  JPanel getPanel();

}