gh-pages / com.nextfaze.devfun.overlay.logger / OverlayLogger
OverlayLogger
interface OverlayLogger (source)
An overlay logger is a floating semi-transparent TextView that will display the .toString() of a function, property, or class.
They are contextually aware if created via @DeveloperLogger (managed by OverlayLogging) and will appear/disappear when in context (if the annotation is within an Activity or Fragment).
- By default it will update every second (see refreshRate).
- If the annotation is on a property also annotated with @DeveloperProperty then a single click will allow you to edit the value (opens the standard DevFun invoker dialog).
- The overlay’s floating behaviour can be configured with a long click (snapping, refresh rate, etc.)
- Overlays can also be configured via. DevFun > Overlays
See Also
Properties
| Name | Summary |
|---|---|
| configurationOptions | abstract val configurationOptions: List<UiField<*>>Additional configuration options for this overlay. |
| enabled | abstract var enabled: BooleanEnabled state of this logger. Delegates to OverlayWindow.enabled. |
| overlay | abstract val overlay: OverlayWindowThe overlay instance used by this logger. |
| refreshRate | abstract var refreshRate: LongHow frequently this overlay should update (in milliseconds). (default: 1000) |
| visibilityScope | abstract var visibilityScope: VisibilityScopeDetermines when an overlay can be visible. Delegates to OverlayWindow.visibilityScope. |
Functions
| Name | Summary |
|---|---|
| resetPositionAndState | abstract fun resetPositionAndState(): UnitReset the position and state to its initial default values and clear its preferences. |
| start | abstract fun start(): UnitAdd this logger to the window and start updating. |
| stop | abstract fun stop(): UnitStop this logger and remove it from the window. |