blob: e0d7d239af835e7789274b50c5894ac9e98de2fa (
plain)
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/*
* Copyright 2015 Open Networking Laboratory
*
* 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 org.onosproject.ui;
import org.onosproject.ui.topo.PropertyPanel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Represents user interface topology view overlay.
*/
public class UiTopoOverlay {
/**
* Logger for this overlay.
*/
protected final Logger log = LoggerFactory.getLogger(getClass());
private final String id;
private boolean isActive = false;
/**
* Creates a new user interface topology view overlay descriptor.
*
* @param id overlay identifier
*/
public UiTopoOverlay(String id) {
this.id = id;
}
/**
* Returns the identifier for this overlay.
*
* @return the identifier
*/
public String id() {
return id;
}
/**
* Callback invoked to initialize this overlay, soon after creation.
* This default implementation does nothing.
*/
public void init() {
}
/**
* Callback invoked when this overlay is activated.
*/
public void activate() {
isActive = true;
}
/**
* Callback invoked when this overlay is deactivated.
*/
public void deactivate() {
isActive = false;
}
/**
* Returns true if this overlay is currently active.
*
* @return true if overlay active
*/
public boolean isActive() {
return isActive;
}
/**
* Callback invoked to destroy this instance by cleaning up any
* internal state ready for garbage collection.
* This default implementation holds no state and does nothing.
*/
public void destroy() {
}
/**
* Callback to modify the contents of the summary panel.
* This default implementation does nothing.
*
* @param pp property panel model of summary data
*/
public void modifySummary(PropertyPanel pp) {
}
/**
* Callback to modify the contents of the details panel for
* a selected device.
* This default implementation does nothing.
*
* @param pp property panel model of summary data
*/
public void modifyDeviceDetails(PropertyPanel pp) {
}
/**
* Callback to modify the contents of the details panel for
* a selected host.
* This default implementation does nothing.
*
* @param pp property panel model of summary data
*/
public void modifyHostDetails(PropertyPanel pp) {
}
}
|
