Widgetset reorganization concretes

Created by Mikaël Geljić, last modified on 2013-09-03

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Parent concept page describes how we should reorganize the widgetset to make it configurable and open for extension. This page highlights the concrete implementation choices (e.g. naming, packaging) that are made to fulfill the concept.

Configuration

New keys in magnolia.properties (empty-webapp)

magnolia.properties

# Change to point at your custom Vaadin widgetset and theme
# Your widgetset should always inherit magnolia's default widgetset (info.magnolia.ui.vaadin.gwt.MagnoliaWidgetSet)
# Your theme should always include magnolia's default theme (admincentral)
magnolia.ui.vaadin.widgetset=info.magnolia.ui.vaadin.gwt.MagnoliaWidgetSet
magnolia.ui.vaadin.theme=admincentral

AdmincentralUIProvider

Package: info.magnolia.ui.admincentral

This is a custom Vaadin UIProvider. It gets the MagnoliaConfigurationProperties via injection, and checks for property values when queried for widgetset or theme. Vaadin's DefaultUIProvider can only resolve widgetsets and themes either from servlet parameters or via annotation.

Property keys are mostly defined as constants in the SystemProperty (info.magnolia.cms.core) deprecated class. In want of a better location for generic magnolia_ui properties, the widgetset and theme properties keys are defined here.

AdmincentralUIProvider.java

public static final String MAGNOLIA_UI_VAADIN_WIDGETSET = "magnolia.ui.vaadin.widgetset";
public static final String MAGNOLIA_UI_VAADIN_THEME = "magnolia.ui.vaadin.theme";

It also holds fallback constants in case widgetset and theme cannot be determined:

AdmincentralUIProvider.java

public static final String DEFAULT_WIDGETSET_NAME = "info.magnolia.ui.vaadin.gwt.MagnoliaWidgetSet";
public static final String DEFAULT_THEME_NAME = "admincentral";

Widgetset structure

	git repo	groupId	artifactId	Widgetset name (.gwt.xml)	gwt:compiled	comments
EE	ee-bundle	info.magnolia.eebundle	magnolia-enterprise-bundle-widgetset	info.magnolia.eebundle.MagnoliaEnterpriseBundleWidgetSet		check for 5.1 EE
EE	enterprise / content-dependencies	info.magnolia.dependencies	magnolia-content-dependencies-widgetset	info.magnolia.dependencies.ContentDependenciesWidgetSet		just here as a ee module example
CE	ce-bundle	info.magnolia.bundle	magnolia-bundle-widgetset	info.magnolia.bundle.MagnoliaBundleWidgetSet		replaces MagnoliaWidgetSet (5.0) - integration and compiler options
	modules / dam	info.magnolia.dam	magnolia-dam-widgetset	info.magnolia.dam.DamWidgetSet		just here as a ce module example
	magnolia_ui / pages	info.magnolia.pages	magnolia-pages-widgetset	info.magnolia.pages.PagesWidgetSet		replaces PageEditorWidgetSet (5.0)
UI	magnolia_ui	info.magnolia.ui	magnolia-ui-widgetset	info.magnolia.ui.MagnoliaUiWidgetSet		replaces CommonWidgetSet (5.0)
	magnolia_ui / magnolia-ui-widgetset	info.magnolia.ui.vaadin	magnolia-ui-vaadin-table	info.magnolia.ui.vaadin.TableWidgetSet		extracted from CommonWidgetSet (5.0)
	magnolia_ui / magnolia-ui-widgetset	info.magnolia.ui.vaadin	magnolia-ui-vaadin-contextmenu	info.magnolia.ui.vaadin.ContextMenuWidgetSet		extracted from CommonWidgetSet (5.0)
	magnolia_ui / magnolia-ui-actionbar	info.magnolia.ui.actionbar	magnolia-ui-actionbar-widgetset	info.magnolia.ui.actionbar.ActionBarWidgetSet		just here as examples for further ui modularization
	magnolia_ui / magnolia-ui-mediaeditor	info.magnolia.ui.mediaeditor	magnolia-ui-mediaeditor-widgetset	info.magnolia.ui.mediaeditor.MediaEditorWidgetSet		just here as examples for further ui modularization
RAW	magnolia-vaadin-widgetset	info.magnolia.vaadin.widgetset	magnolia-vaadin-widgetset	info.magnolia.vaadin.MagnoliaWidgetSet		M5-agnostic vaadin components - not for now

Theme structure

-

No labels