23.1 Embeddable Beans - Overview

A bean can be embedded into a page(.xpg) using


	<bean id="bean1" type="beanType">
		...
	</bean>

A module can create embeddable beans by implementing createEmbeddableBean(...) method:


	@Override
	public BackingBean createEmbeddableBean(Component parentComponent, String beanType,
			Element beanElem, ContainerBean containerBean) throws SystemException {
	}

An embeddable bean is a backing bean (i.e., EntityBackingBean, EntityListBackingBean or MenuBean), and it is interactive supporting partial behaviors. The viewConfig element configures how the embedded bean will be rendered and interacted with users, including properties, layout, render style, access control, partial behaviors, pagination, etc. See View Config.

Each bean has an id, and it must be unique within a page.

Built-in embeddable bean types are: login, entity, entities, menu and FTP. For example, use bean type "entity" for showing/editing/creating a single entity or querying Employee entities, and use bean type "entities" for showing a pageable list of Employee entities matching a criteria.

See Site module documentation for more details on pages(.xpg). Site module supports both web and multi-platform such as iOS and Android.

← EL Expressions→ Embedded Beans: RegionFrames / No Frames