blob: ab3a40ec5ab24b4b6cacb4e7edd5dc570280af6d (
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
package com.pitchedapps.frost.contracts
import android.view.View
import com.pitchedapps.frost.facebook.FbItem
import io.reactivex.subjects.BehaviorSubject
import io.reactivex.subjects.PublishSubject
/**
* Created by Allan Wang on 20/12/17.
*/
/**
* Contract for the underlying parent,
* binds to activities & fragments
*/
interface FrostContentContainer {
val baseUrl: String
val baseEnum: FbItem?
/**
* Update toolbar title
*/
fun setTitle(title: String)
}
/**
* Contract for components shared among
* all content providers
*/
interface FrostContentParent : DynamicUiContract {
val core: FrostContentCore
/**
* Observable to get data on whether view is refreshing or not
*/
val refreshObservable: PublishSubject<Boolean>
/**
* Observable to get data on refresh progress, with range [0, 100]
*/
val progressObservable: PublishSubject<Int>
/**
* Observable to get new title data (unique values only)
*/
val titleObservable: BehaviorSubject<String>
var baseUrl: String
var baseEnum: FbItem?
/**
* Toggle state for allowing swipes
*/
var swipeEnabled: Boolean
/**
* Binds the container to self
* this will also handle all future bindings
* Must be called by container!
*/
fun bind(container: FrostContentContainer)
/**
* Signal that the contract will not be used again
* Clean up resources where applicable
*/
fun destroy()
/**
* Hook onto the refresh observable for one cycle
* Animate toggles between the fancy ripple and the basic fade
* The cycle only starts on the first load since
* there may have been another process when this is registered
*
* Returns true to proceed with load
* In some cases when the url has not changed,
* it may not be advisable to proceed with the load
* For those cases, we will return false to stop it
*/
fun registerTransition(urlChanged: Boolean, animate: Boolean): Boolean
}
/**
* Underlying contract for the content itself
*/
interface FrostContentCore : DynamicUiContract {
/**
* Reference to parent
* Bound through calling [FrostContentParent.bind]
*/
var parent: FrostContentParent
/**
* Initializes view through given [container]
*
* The content may be free to extract other data from
* the container if necessary
*
* [parent] must be bounded before calling this!
*/
fun bind(container: FrostContentContainer): View
/**
* Call to reload wrapped data
*/
fun reload(animate: Boolean)
/**
* Call to reload base data
*/
fun reloadBase(animate: Boolean)
/**
* If possible, remove anything in the view stack
* Applies namely to webviews
*/
fun clearHistory()
/**
* Should be called when a back press is triggered
* Return [true] if consumed, [false] otherwise
*/
fun onBackPressed(): Boolean
val currentUrl: String
/**
* Condition to help pause certain background resources
*/
var active: Boolean
/**
* Triggered when view is within viewpager
* and tab is clicked
*/
fun onTabClicked()
/**
* Signal destruction to release some content manually
*/
fun destroy()
}
|
