Package org.opencms.ui.sitemap

Class CmsLocaleComparePanel

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractComponentContainer

com.vaadin.ui.AbstractLayout

com.vaadin.ui.AbstractOrderedLayout

com.vaadin.ui.VerticalLayout

com.vaadin.v7.ui.VerticalLayout

org.opencms.ui.sitemap.CmsLocaleComparePanel

All Implemented Interfaces:

com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.LayoutEvents.LayoutClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, Serializable, Iterable<com.vaadin.ui.Component>, I_CmsLocaleCompareContext

public class CmsLocaleComparePanel
extends com.vaadin.v7.ui.VerticalLayout
implements I_CmsLocaleCompareContext

View used to compare sitemaps across locales.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Layout

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field	Description
protected com.vaadin.ui.CssLayout	m_treeContainer	The parent layout of the tree.
static final com.vaadin.server.Resource	MAIN_LOCALE_ICON	Icon for the main locale option in select boxes.

Fields inherited from class com.vaadin.ui.AbstractOrderedLayout

ALIGNMENT_DEFAULT, components

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor	Description
CmsLocaleComparePanel(String id)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Locale	getComparisonLocale()	Gets the comparison locale.
List<Locale>	getComparisonLocales()	Gets the locales selectable as comparison locales.
CmsLocaleGroup	getLocaleGroup()	Gets the locale group of the root resource.
CmsResource	getRoot()	Gets the root resource.
Locale	getRootLocale()	Gets the root locale.
void	initialize(CmsUUID id, Locale initialComparisonLocale)	Initializes the locale comparison view.
protected void	initTree(CmsResource rootRes)	Initializes the tree with the given resource as a root.
void	refreshAll()	Refreshes everything.
void	switchToLocale(Locale locale)	Switches the root locale to the given value.
protected void	updateLocaleWidgets()	Shows the current loale values in their corresponding widgets.

Methods inherited from class com.vaadin.ui.VerticalLayout

addComponentsAndExpand, getState, getState

Methods inherited from class com.vaadin.ui.AbstractOrderedLayout

addComponent, addComponent, addComponentAsFirst, addLayoutClickListener, getComponent, getComponentAlignment, getComponentCount, getComponentIndex, getCustomAttributes, getDefaultComponentAlignment, getExpandRatio, getMargin, isSpacing, iterator, readDesign, removeComponent, removeLayoutClickListener, replaceComponent, setComponentAlignment, setDefaultComponentAlignment, setExpandRatio, setMargin, setMargin, setSpacing, writeDesign

Methods inherited from class com.vaadin.ui.AbstractLayout

readMargin, writeMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addComponents, fireComponentAttachEvent, fireComponentDetachEvent, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponentAttachListener, removeComponentDetachListener, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponents, getComponentIterator, moveComponentsFrom, removeAllComponents

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Field Details

MAIN_LOCALE_ICON

public static final com.vaadin.server.Resource MAIN_LOCALE_ICON

Icon for the main locale option in select boxes.

m_treeContainer

protected com.vaadin.ui.CssLayout m_treeContainer

The parent layout of the tree.

Constructor Details

CmsLocaleComparePanel

public CmsLocaleComparePanel(String id)

Creates a new instance.

Parameters:

id - the id of a sitemap entry

Method Details

getComparisonLocale

public Locale getComparisonLocale()

Description copied from interface: I_CmsLocaleCompareContext

Gets the comparison locale.

Specified by:

getComparisonLocale in interface I_CmsLocaleCompareContext

Returns:

the comparison locale

See Also:

• I_CmsLocaleCompareContext.getComparisonLocale()

getComparisonLocales

public List<Locale> getComparisonLocales()

Gets the locales selectable as comparison locales.

Returns:

the possible comparison locales

getLocaleGroup

public CmsLocaleGroup getLocaleGroup()

Description copied from interface: I_CmsLocaleCompareContext

Gets the locale group of the root resource.

Specified by:

getLocaleGroup in interface I_CmsLocaleCompareContext

Returns:

the locale group of the root resource

See Also:

• I_CmsLocaleCompareContext.getLocaleGroup()

getRoot

public CmsResource getRoot()

Description copied from interface: I_CmsLocaleCompareContext

Gets the root resource.

Specified by:

getRoot in interface I_CmsLocaleCompareContext

Returns:

the root resource

See Also:

• I_CmsLocaleCompareContext.getRoot()

getRootLocale

public Locale getRootLocale()

Description copied from interface: I_CmsLocaleCompareContext

Gets the root locale.

Specified by:

getRootLocale in interface I_CmsLocaleCompareContext

Returns:

the root locale

See Also:

• I_CmsLocaleCompareContext.getRootLocale()

initialize

public void initialize(CmsUUID id,
 Locale initialComparisonLocale)
                throws CmsException

Initializes the locale comparison view.

Parameters:

id - the structure id of the currrent sitemap root entry

initialComparisonLocale - if not null, the initially selected ccomparison locale

Throws:

CmsException - if something goes wrong

refreshAll

public void refreshAll()

Description copied from interface: I_CmsLocaleCompareContext

Refreshes everything.

Specified by:

refreshAll in interface I_CmsLocaleCompareContext

See Also:

• I_CmsLocaleCompareContext.refreshAll()

switchToLocale

public void switchToLocale(Locale locale)
                    throws CmsException

Switches the root locale to the given value.

Parameters:

locale - the new root locale

Throws:

CmsException - if something goes wrong

initTree

protected void initTree(CmsResource rootRes)
                 throws CmsException

Initializes the tree with the given resource as a root.

Parameters:

rootRes - the new tree root resource

Throws:

CmsException - if something goes wrong

updateLocaleWidgets

protected void updateLocaleWidgets()

Shows the current loale values in their corresponding widgets.