BuildingElementComposite

Implementation of the build element composite

BuildingElementComposite

Canonical path: BuildingElementComposite.BuildingElementComposite

Bases: BuildingElementCompositeData

Implementation of class BuildingElementComposite

connect_building_element_values

connect_building_element_values(
    build_ele_list: List[BuildingElement],
    end_index: int = -1,
    check_modified: bool = True,
) -> bool

Connect the values of the building element from the element data

Return: the connection is modified: True/False

Parameters:

build_ele_list (List[BuildingElement]) –

Building element list
end_index (int, default: -1 ) –

end index
check_modified (bool, default: True ) –

check modified state

Returns:

bool –

modified state

get_build_ele_index

get_build_ele_index(build_ele_id: str) -> int

get the index of the building element by the ID

Parameters:

build_ele_id (str) –

id fo find

Returns:

int –

index of the ID

get_composite_build_ele_list

get_composite_build_ele_list(
    sub_ele_index: int, build_ele_list: List[BuildingElement]
) -> Tuple[List[BuildingElement], List[int]]

Get a tuple with the - list with the sub building elements - list with the indices of the sub building elements

Parameters:

sub_ele_index (int) –

Index of the sub element
build_ele_list (List[BuildingElement]) –

List with the building elements

Returns:

Tuple[List[BuildingElement], List[int]] –

tuple with the lists

get_element_palette_data

get_element_palette_data(element_id: str) -> PaletteData

Set the palette data for the element (control index, page text, expander text)

Parameters:

element_id (str) –

element ID

Returns:

PaletteData –

palette data

get_script

get_script(sub_ele_index: int) -> object

Get the script of the sub element

Return: script

Parameters:

sub_ele_index (int) –

Index of the sub element

Returns:

object –

script name

get_sub_element_name

get_sub_element_name(sub_ele_index: int) -> str

Get the name of the sub element

Return: name

Parameters:

sub_ele_index (int) –

Index of the sub element

Returns:

str –

sub element name

get_values_from_list `staticmethod`

get_values_from_list(value_list: List[Any], sub_name: str) -> List[Any]

get the values from a list

Parameters:

value_list (List[Any]) –

value list
sub_name (str) –

sub value name

Returns:

List[Any] –

value

is_element_visible

is_element_visible(
    ele_index: int, build_ele_list: List[BuildingElement]
) -> bool

Check for a visible element

Return: the element is visible: True/False

Parameters:

ele_index (int) –

element index
build_ele_list (List[BuildingElement]) –

Building element list

Returns:

bool –

element visible state

set_connection_persistence

set_connection_persistence(build_ele_list: List[BuildingElement])

Set the persistence for the connected parameter

Parameters:

build_ele_list (List[BuildingElement]) –

building element list

set_element_visible

set_element_visible(ele_index: int, value: str)

Set the visible state for the element

Parameters:

ele_index (int) –

element index
value (str) –

value

BuildingElementComposite