-
Notifications
You must be signed in to change notification settings - Fork 113
/
provider.go
60 lines (51 loc) · 2.08 KB
/
provider.go
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
// Copyright 2018-2020 CERN
//
// 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.
//
// In applying this license, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
package html
import (
"net/http"
)
const (
// ContinueExecution causes the execution of a panel to continue.
ContinueExecution = true
// AbortExecution causes the execution of a panel to be aborted.
AbortExecution = false
)
// ExecutionResult is the type returned by the PreExecute function of PanelProvider.
type ExecutionResult = bool
// PanelProvider handles general panel tasks.
type PanelProvider interface {
// GetActiveTemplate returns the name of the active template.
GetActiveTemplate(*Session, string) string
// PreExecute is called before the actual template is being executed.
PreExecute(*Session, string, http.ResponseWriter, *http.Request) (ExecutionResult, error)
}
// PanelDataProvider is the function signature for panel data providers.
type PanelDataProvider = func(*Session) interface{}
// ContentProvider defines various methods for HTML content providers.
type ContentProvider interface {
// GetTitle returns the title of the panel.
GetTitle() string
// GetCaption returns the caption which is displayed on the panel.
GetCaption() string
// GetContentJavaScript delivers additional JavaScript code.
GetContentJavaScript() string
// GetContentStyleSheet delivers additional stylesheet code.
GetContentStyleSheet() string
// GetContentBody delivers the actual body content.
GetContentBody() string
}