Module: key_list_view
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 cl.runtime import View
from cl.runtime.records.dataclasses_extensions import missing
@dataclass(slots=True, kw_only=True)
class KeyListView(View):
"""List of generic keys in ClassName;key_field_1;key_field_2 format, records are loaded and displayed."""
key_list: List[str] = missing()
"""List of generic keys in ClassName;key_field_1;key_field_2 format, records are loaded and displayed."""
Classes
class KeyListView (*, view_for: str = None, view_name: str = None, key_list: List[str] = None)
-
List of generic keys in ClassName;key_field_1;key_field_2 format, records are loaded and displayed.
Expand source code
@dataclass(slots=True, kw_only=True) class KeyListView(View): """List of generic keys in ClassName;key_field_1;key_field_2 format, records are loaded and displayed.""" key_list: List[str] = missing() """List of generic keys in ClassName;key_field_1;key_field_2 format, records are loaded and displayed."""
Ancestors
- View
- ViewKey
- KeyMixin
- RecordMixin
- abc.ABC
- typing.Generic
Static methods
def get_key_type() -> Type
-
Inherited from:
View
.get_key_type
Return key type even when called from a record.
Fields
var key_list -> List[str]
-
List of generic keys in ClassName;key_field_1;key_field_2 format, records are loaded and displayed.
var view_for -> str
-
Generic key in ClassName;key_field_1;key_field_2 format of the record for which the view is provided.
var view_name -> str
-
Inherited from:
View
.view_name
Name of the view displayed in the front end.
Methods