Source code for enamlnative.android.android_toast

"""
Copyright (c) 2017-2022, CodeLV.

Distributed under the terms of the MIT License.

The full license is in the file LICENSE, distributed with this software.

Created on Sept 18, 2017


"""
from asyncio import Future
from atom.api import Bool, Typed
from enamlnative.widgets.toast import ProxyToast
from .android_content import Context
from .android_toolkit_object import AndroidToolkitObject
from .bridge import JavaBridgeObject, JavaMethod, JavaStaticMethod


class Toast(JavaBridgeObject):
    #: Show the view for the specified duration.
    __nativeclass__ = "android.widget.Toast"
    __signature__ = [Context]
    makeText = JavaStaticMethod(
        Context,
        "java.lang.CharSequence",
        int,
        returns="android.widget.Toast",
    )
    show = JavaMethod()
    cancel = JavaMethod()
    setDuration = JavaMethod(int)
    setGravity = JavaMethod(int, int, int)
    setText = JavaMethod("java.lang.CharSequence")
    setView = JavaMethod("android.view.View")


[docs]class AndroidToast(AndroidToolkitObject, ProxyToast):
    """An Android implementation of an Enaml ProxyToast."""

    #: A reference to the widget created by the proxy.
    toast = Typed(Toast)

    #: Made toast
    #: Android doesn't let us simply update the text of an existing toast
    #: unless it was created with "makeToast"
    made_toast = Bool()

    # -------------------------------------------------------------------------
    # Initialization API
    # -------------------------------------------------------------------------
[docs]    def create_widget(self):
        """Create the underlying widget.

        A toast is not a subclass of view, hence we don't set name as widget
        or children will try to use it as their parent (which crashes).

        """
        d = self.declaration
        if d.text:
            f = Toast.makeText(self.get_context(), d.text, 1)
            f.add_done_callback(self.on_make_toast)
            self.made_toast = True
        else:
            self.toast = Toast(self.get_context())

[docs]    def init_widget(self):
        """Our widget may not exist yet so we have to diverge from the normal
        way of doing initialization. See `update_widget`

        """
        if not self.toast:
            return
        super().init_widget()

        d = self.declaration
        if not self.made_toast:
            #: Set it to LONG
            self.toast.setDuration(1)
        if d.gravity:
            self.set_gravity(d.gravity)
        if d.show:
            self.set_show(d.show)

[docs]    def init_layout(self):
        """If a view is given show it"""
        super().init_layout()
        if not self.made_toast:
            for view in self.child_widgets():
                self.toast.setView(view)
                break

[docs]    def child_added(self, child):
        """Overwrite the view"""
        view = child.widget
        if view is not None:
            toast = self.toast
            assert toast is not None
            toast.setView(view)

[docs]    def on_make_toast(self, f: Future):
        """Using Toast.makeToast returns async so we have to initialize it
        later.

        """
        toast_id = f.result()
        self.toast = Toast(__id__=toast_id)
        self.init_widget()

    def _refresh_show(self, dt: int):
        """While the toast.show is true, keep calling .show() until the
        duration `dt` expires.

        Parameters
        ------------
        dt: int
            Time left to keep showing

        """
        d = self.declaration
        assert d is not None
        if dt <= 0:
            #: Done, hide
            d.show = False
        elif d.show:
            #: If user didn't cancel it, keep it alive
            toast = self.toast
            assert toast is not None
            toast.show()

            t = min(1000, dt)
            app = self.get_context()
            app.timed_call(t, self._refresh_show, dt - t)

    # -------------------------------------------------------------------------
    # ProxyToast API
    # -------------------------------------------------------------------------
    def set_text(self, text: str):
        #: Only possible if a custom view is not used
        if self.made_toast:
            toast = self.toast
            assert toast is not None
            toast.setText(text)

[docs]    def set_duration(self, duration: int):
        """Android for whatever stupid reason doesn't let you set the time
        it only allows 1-long or 0-short. So we have to repeatedly call show
        until the duration expires, hence this method does nothing see
        `set_show`.

        """
        pass

    def set_show(self, show: bool):
        toast = self.toast
        assert toast is not None
        if show:
            d = self.declaration
            assert d is not None
            toast.show()

            #: Get app
            app = self.get_context()
            t = min(1000, d.duration)
            app.timed_call(t, self._refresh_show, d.duration - t)
        else:
            toast.cancel()

    def set_layout(self, layout):
        pass

    def set_gravity(self, gravity: int):
        d = self.declaration
        assert d is not None
        toast = self.toast
        assert toast is not None
        toast.setGravity(gravity, int(d.x), int(d.y))