GUI model#

class besser.BUML.metamodel.gui.graphical_ui.Application(name: str, package: str, versionCode: str, versionName: str, modules: set[Module], description: str, screenCompatibility: bool = False)[source]#

Bases: Model

It is a subclass of the NamedElement class and encapsulates the properties and behavior of an application, including its name,: package, version code, version name, modules, description, and screen compatibility.

Parameters:

name (str) – The name of the application.
package (str) – The package of the application.
versionCode (str) – The version code of the application.
versionName (str) – The version name of the application.
modules (set[Module]) – The set of modules contained in the application.
description (str) – The description of the application.
screenCompatibility (bool) – Indicates whether the application has screen compatibility.

name#

The name of the application.

Type:: str

package#

The package of the application.

Type:: str

versionCode#

The version code of the application.

Type:: str

versionName#

The version name of the application.

Type:: str

modules#

The set of modules contained in the application.

Type:: set[Module]

description#

The description of the application.

Type:: str

screenCompatibility#

Indicates whether the application has screen compatibility.

Type:: bool

_abc_impl = <_abc._abc_data object>#

property description: str#

Get the description of the application.

Type:: str

property modules: set[Module]#

Get the set of modules contained in the application.

Type:: set[Module]

property package: str#

Get the package of the application.

Type:: str

property screenCompatibility: bool#

Get the screen compatibility of the application.

Type:: bool

property versionCode: str#

Get the version code of the application.

Type:: str

property versionName: str#

Get the version name of the application.

Type:: str

class besser.BUML.metamodel.gui.graphical_ui.Button(name: str, description: str, Label: str)[source]#

Bases: ViewComponent

Represents a button component and encapsulates specific properties of a button, such as its name and label.

Parameters:

name (str) – The name of the button.
label (str) – The label of the button.

name#

The name of the button.

Type:: str

label#

The label of the button.

Type:: str

property Label: str#

Get the label of the button.

Type:: str

_abc_impl = <_abc._abc_data object>#

class besser.BUML.metamodel.gui.graphical_ui.Collection(name: str, type: CollectionSourceType)[source]#

Bases: DataSource

Represents a data source that is a collection.

Parameters:

name (str) – The name of the collection data source.
type (CollectionSourceType) – The type of the collection data source.

name#

The name of the collection data source.

Type:: str

type#

The type of the collection data source.

Type:: CollectionSourceType

property type: CollectionSourceType#

Get the type of the collection data source.

Type:: CollectionSourceType

class besser.BUML.metamodel.gui.graphical_ui.CollectionSourceType(name: str, type: str)[source]#

Bases: object

Represents the type of a collection source.

Parameters:

name (str) – The name of the collection source type.
type (str) – The type of the collection source, such as ‘List’, ‘Table’, ‘Tree’, ‘Grid’, ‘Array’, or ‘Stack’.

name#

The name of the collection source type.

Type:: str

type#

The type of the collection source, such as ‘List’, ‘Table’, ‘Tree’, ‘Grid’, ‘Array’, or ‘Stack’.

Type:: str

property name: str#

Get the name of the collection source type.

Type:: str

property type: str#

Get the type of the collection source.

Type:: str

class besser.BUML.metamodel.gui.graphical_ui.DataSource(name: str)[source]#

Bases: object

Represents a data source.

Parameters:: name (str) – The name of the data source.

name#

The name of the data source.

Type:: str

property name: str#

Get the name of the data source.

Type:: str

class besser.BUML.metamodel.gui.graphical_ui.File(name: str, type: FileSourceType)[source]#

Bases: DataSource

Represents a data source that is a file.

Parameters:

name (str) – The name of the file data source.
type (FileSourceType) – The type of the file data source.

name#

The name of the file data source.

Type:: str

type#

The type of the file data source.

Type:: FileSourceType

property type: FileSourceType#

Get the type of the file data source.

Type:: FileSourceType

class besser.BUML.metamodel.gui.graphical_ui.FileSourceType(name: str, type: str)[source]#

Bases: object

Represents the type of a file source.

Parameters:

name (str) – The name of the file source type.
type (str) – The type of the file source, such as ‘FileSystem’, ‘LocalStorage’, or ‘DatabaseFileSystem’.

name#

The name of the file source type.

Type:: str

type#

The type of the file source, such as ‘FileSystem’, ‘LocalStorage’, or ‘DatabaseFileSystem’.

Type:: str

property name: str#

Get the name of the file source type.

Type:: str

property type: str#

Get the type of the file source.

Type:: str

class besser.BUML.metamodel.gui.graphical_ui.Form(name: str, description: str, inputFields: set[InputField])[source]#

Bases: ViewComponent

Represents a form component and encapsulates the specific properties of a form, such as its name.

Parameters:

name (str) – The name of the form.
description (str) – The description of the form.
inputFields (set[InputField]) – The set of input fields contained in the form.

name#

The name of the form.

Type:: str

description#

The description of the form.

Type:: str

inputFields#

The set of input fields contained in the form.

Type:: set[InputField]

_abc_impl = <_abc._abc_data object>#

property inputFields: set[InputField]#

Get the set of input Fields contained in the form.

Type:: set[Module]

class besser.BUML.metamodel.gui.graphical_ui.Image(name: str, description: str)[source]#

Bases: ViewComponent

Represents an image component and encapsulates the specific properties of a image, such as its name.

Parameters:: name (str) – The name of the image.

name#

The name of the image.

Type:: str

_abc_impl = <_abc._abc_data object>#

class besser.BUML.metamodel.gui.graphical_ui.InputField(name: str, description: str, fieldType: str, validationRules: str)[source]#

Bases: ViewComponent

Represents an input field component and encapsulates specific properties of an input field, such as its type and validation rules.

Args:
name (str): The name of the input field. description (str): The description of the input field. fieldType (str): The type of the input field. validationRules (str): The validation rules for the input field.

name#

The name of the input field.

Type:: str

description#

The description of the input field.

Type:: str

fieldType#

The type of the input field.

Type:: str

validationRules#

The validation rules for the input field.

Type:: str

_abc_impl = <_abc._abc_data object>#

property fieldType: str#

Get the type of the field.

Type:: str

property validationRules: str#

Get the validation rules of the input field.

Type:: set[MenuItem]

class besser.BUML.metamodel.gui.graphical_ui.List(name: str, description: str, list_sources: set[DataSource])[source]#

Bases: ViewComponent

Represents a list component that encapsulates properties unique to lists, such as list sources.

Parameters:

name (str) – The name of the list.
list_sources (set[DataSource]) – The set of data sources associated with the list.

name#

The name of the list.

Type:: str

list_sources#

The set of data sources associated with the list.

Type:: set[DataSource]

_abc_impl = <_abc._abc_data object>#

property list_sources: set[DataSource]#

Get the set of data sources associated with the list.

Type:: set[DataSource]

class besser.BUML.metamodel.gui.graphical_ui.Menu(name: str, description: str, menuItems: set[MenuItem])[source]#

Bases: ViewComponent

Represents a menu component and encapsulates the specific properties of a menu, such as its name.

Parameters:

name (str) – The name of the menu.
description (str) – The description of the menu.
menuItems (set[MenuItem]) – The set of menu items contained in the menu.

name#

The name of the menu.

Type:: str

description#

The description of the menu.

Type:: str

menuItems#

The set of menu items contained in the menu.

Type:: set[MenuItem]

_abc_impl = <_abc._abc_data object>#

property menuItems: set[MenuItem]#

Get the set of menuItems.

Type:: set[MenuItem]

class besser.BUML.metamodel.gui.graphical_ui.MenuItem(label: str)[source]#

Bases: object

Represents an item of a menu.

Parameters:: label (str) – The label of the menu item.

label#

The label of the menu item.

Type:: str

class besser.BUML.metamodel.gui.graphical_ui.ModelElement(name: str, dataSourceClass: Class, fields: set[Property])[source]#

Bases: DataSource

Represents a data source associated with a model element.

Parameters:

name (str) – The name of the model element data source.
dataSourceClass (Class) – The class representing the data source.
fields – set[Property]: The fields representing the attributes of the model element.

name#

The name of the model element data source.

Type:: str

dataSourceClass#

The class representing the data source.

Type:: Class

fields#: set[Property]: The fields representing the attributes of the model element.

property dataSourceClass: Class#

Get the class representing the data source.

Type:: Class

property fields: set[Property]#

Get the set of properties (fields) of the model element.

Type:: set[Property]

class besser.BUML.metamodel.gui.graphical_ui.Module(name: str, screens: set[Screen], visibility: str = 'public')[source]#

Bases: NamedElement

Represents a module.

Parameters:

name (str) – name (str): The name of the module.
screens (set[Screen]) – The set of screens contained in the module.

name#

name (str): The name of the module.

Type:: str

screens#

The set of screens contained in the module.

Type:: set[Screen]

_abc_impl = <_abc._abc_data object>#

property screens: set[Screen]#

Get the set of screens contained.

Type:: set[Screen]

class besser.BUML.metamodel.gui.graphical_ui.Screen(name: str, description: str, components: set[ViewComponent], x_dpi: str, y_dpi: str, size: str)[source]#

Bases: ViewContainer

Represents a screen.

Parameters:

name (str) – The name of the screen.
components (set[ViewComponent]) – The set of view components on the screen.
x_dpi (str) – The X DPI (dots per inch) of the screen.
y_dpi (str) – The Y DPI (dots per inch) of the screen.
size (str) – The size of the screen.

name#

The name of the screen.

Type:: str

components#

The set of view components on the screen.

Type:: set[ViewComponent]

x_dpi#

The X DPI (dots per inch) of the screen.

Type:: str

y_dpi#

The Y DPI (dots per inch) of the screen.

Type:: str

size#

The size of the screen.

Type:: str

_abc_impl = <_abc._abc_data object>#

property components: set[ViewComponent]#

Get the set of view components on the screen.

Type:: set[ViewComponent]

property size: str#

Get the size of the screen.

Type:: str

property x_dpi: str#

Get the X DPI (dots per inch) of the screen.

Type:: str

property y_dpi: str#

Get the Y DPI (dots per inch) of the screen.

Type:: str

class besser.BUML.metamodel.gui.graphical_ui.ViewComponent(name: str, description: str)[source]#

Bases: ViewElement

Represents a view component.

Parameters:

name (str) – The name of the view component.
description (str) – The description of the view component.

name#

The name of the view component.

Type:: str

description#

The description of the view component.

Type:: str

_abc_impl = <_abc._abc_data object>#

class besser.BUML.metamodel.gui.graphical_ui.ViewContainer(name: str, description: str)[source]#

Bases: ViewElement

Represents a view container.

Parameters:

name (str) – The name of the view container.
description (str) – The description of the view container.

name#

The name of the view container.

Type:: str

description#

The description of the view container.

Type:: str

_abc_impl = <_abc._abc_data object>#

class besser.BUML.metamodel.gui.graphical_ui.ViewElement(name: str, description: str, visibility: str = 'public')[source]#

Bases: NamedElement

Represents a view element.

Parameters:

name (str) – The name of the view element.
description (str) – the description of the view element.

name#

The name of the view element.

Type:: str

description#

the description of the view element.

Type:: str

_abc_impl = <_abc._abc_data object>#

property description: str#

Get the description of the view element.

Type:: str