Source code for ckg.report_manager.apps.basicApp

import dash_html_components as html


[docs]class BasicApp:
    """
    Defines what an App is in the report_manager.
    Other Apps will inherit basic functionality from this class.
    Attributes: Title, subtitle, description, logo, footer.
    """
    def __init__(self, title, subtitle, description, page_type, layout=[], logo=None, footer=None):
        self._title = title
        self._subtitle = subtitle
        self._description = description
        self._page_type = page_type
        self._logo = logo
        self._footer = footer
        self._layout = layout
    
    @property
    def title(self):
        return self._title

    @title.setter
    def title(self, title):
        self._title = title

    @property
    def subtitle(self):
        return self._subtitle

    @subtitle.setter
    def subtitle(self, subtitle):
        self._subtitle = subtitle

    @property
    def description(self):
        return self._description

    @description.setter
    def description(self, description):
        self._description = description
    
    @property
    def page_type(self):
        return self._page_type

    @page_type.setter
    def page_type(self, page_type):
        self._page_type = page_type

    @property
    def logo(self):
        return self._logo

    @logo.setter
    def logo(self, logo):
        self._logo = logo

    @property
    def footer(self):
        return self._footer

    @footer.setter
    def footer(self, footer):
        self._footer = footer

    @property
    def layout(self):
        return self._layout

    @layout.setter
    def layout(self, layout):
        self._layout = layout

[docs]    def add_to_layout(self, section):
        self.layout.append(section)

[docs]    def extend_layout(self, sections):
        self.layout.extend(sections)

[docs]    def get_HTML_title(self):
        return html.H1(children=self.title)

[docs]    def get_HTML_subtitle(self):
        return html.H2(children=self.subtitle)

[docs]    def get_HTML_description(self):
        return html.Div(children=self.description)

[docs]    def add_basic_layout(self):
        """
        Calls class functions to setup the layout: title, subtitle, description, \
        logo and footer.
        """
        self.layout.append(html.Div([html.Form([html.Button('Logout', type='submit')], action='/apps/logout', method='post',
                                               style={'display': 'none', 'position': 'absolute', 'right': '0px'}, id='logout_form')]))
        self.layout.append(html.Div(html.H2('Invalid user name or password', className='error_msg'), id='error_msg', style={'display': 'none'}))
        if self.title is not None:
            self.layout.append(self.get_HTML_title())
        if self.subtitle is not None:
            self.layout.append(self.get_HTML_subtitle())
        if self.description is not None:
            self.layout.append(self.get_HTML_description())
        if self.logo is not None:
            self.layout.append(self.logo)
        if self.footer is not None:
            self.layout.append(self.footer)

[docs]    def build_page(self):
        """
        Builds page basic layout.
        """
        self.add_basic_layout()