Module: ui_type_state

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# 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.

from dataclasses import dataclass
from typing import List
from typing import Optional
from typing import final
from cl.runtime.backend.core.ui_type_state_key import UiTypeStateKey
from cl.runtime.records.dataclasses_extensions import field
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.record_mixin import RecordMixin


@final
@dataclass(slots=True, kw_only=True)
class UiTypeState(UiTypeStateKey, RecordMixin[UiTypeStateKey]):
    """Defines ui settings for a type."""

    read_only: Optional[bool] = missing()
    """Specifies if records of this type are readonly."""

    use_cache: Optional[bool] = missing()
    """
    If set and TRUE data will be cached until tab is opened. This means that the next time the tab is
    activated, the main grid data request will not be submitted, it will be taken from the browser cache.
    """

    pinned_handlers: Optional[List[str]] = missing()
    """List of names of the handlers pinned for the type"""

    def get_key(self) -> UiTypeStateKey:
        return UiTypeStateKey(type_=self.type_, user=self.user)

Classes

class UiTypeState (*, type_: TypeDeclKey = None, user: UserKey | None = None, read_only: bool | None = None, use_cache: bool | None = None, pinned_handlers: Optional[List[str]] = None)

Defines ui settings for a type.

Expand source code

@final
@dataclass(slots=True, kw_only=True)
class UiTypeState(UiTypeStateKey, RecordMixin[UiTypeStateKey]):
    """Defines ui settings for a type."""

    read_only: Optional[bool] = missing()
    """Specifies if records of this type are readonly."""

    use_cache: Optional[bool] = missing()
    """
    If set and TRUE data will be cached until tab is opened. This means that the next time the tab is
    activated, the main grid data request will not be submitted, it will be taken from the browser cache.
    """

    pinned_handlers: Optional[List[str]] = missing()
    """List of names of the handlers pinned for the type"""

    def get_key(self) -> UiTypeStateKey:
        return UiTypeStateKey(type_=self.type_, user=self.user)

Ancestors

UiTypeStateKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Static methods

def get_key_type() -> Type: Inherited from: UiTypeStateKey.get_key_type

Return key type even when called from a record.

Fields

var pinned_handlers -> Optional[List[str]]: List of names of the handlers pinned for the type
var read_only -> bool | None: Specifies if records of this type are readonly.
var type_ -> TypeDeclKey: Inherited from: UiTypeStateKey.type_

Type reference.
var use_cache -> bool | None: If set and TRUE data will be cached until tab is opened. This means that the next time the tab is activated, the main grid data request will not be submitted, it will be taken from the browser cache.
var user -> UserKey | None: Inherited from: UiTypeStateKey.user

A user the app state is applied for.

Methods

def get_key(self) -> UiTypeStateKey: Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None: Inherited from: RecordMixin.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.