org.opencms.ui.apps

Class CmsDefaultAppButtonProvider

java.lang.Object

org.opencms.ui.apps.CmsDefaultAppButtonProvider

All Implemented Interfaces:

I_CmsAppButtonProvider

public class CmsDefaultAppButtonProvider
extends java.lang.Object
implements I_CmsAppButtonProvider

The default app button provider.

Field Summary

Fields inherited from interface org.opencms.ui.apps.I_CmsAppButtonProvider

BUTTON_STYLE_BLUE, BUTTON_STYLE_CLASSIC, BUTTON_STYLE_CYAN, BUTTON_STYLE_GRAY, BUTTON_STYLE_ORANGE, BUTTON_STYLE_RED, BUTTON_STYLE_TRANSPARENT

Constructor Summary

Constructors

Constructor and Description
CmsDefaultAppButtonProvider()

Method Summary

Modifier and Type	Method and Description
static com.vaadin.ui.Component	createAppButton(CmsObject cms, I_CmsWorkplaceAppConfiguration appConfig, java.util.Locale locale) Creates a properly styled button for the given app.
com.vaadin.ui.Component	createAppButton(I_CmsWorkplaceAppConfiguration appConfig) Creates an app launcher button.
com.vaadin.ui.Component	createAppFolderButton(CmsAppCategoryNode node) Creates an app folder button.
static com.vaadin.ui.Component	createAppFolderButton(CmsObject cms, CmsAppCategoryNode node, java.util.Locale locale) Creates a properly styled button for the given app.
static com.vaadin.ui.Button	createAppFolderIconButton(I_CmsFolderAppCategory appCat, java.util.Locale locale) Creates a properly styled button for the given app, without adding a click handler or checking visibility settings.
static com.vaadin.ui.Button	createAppIconButton(I_CmsWorkplaceAppConfiguration appConfig, java.util.Locale locale) Creates a properly styled button for the given app, without adding a click handler or checking visibility settings.
static com.vaadin.ui.Button	createIconButton(java.lang.String name, java.lang.String description, com.vaadin.server.Resource icon) Creates an icon button.
static com.vaadin.ui.Button	createIconButton(java.lang.String name, java.lang.String description, com.vaadin.server.Resource icon, java.lang.String buttonStyle) Creates an icon button.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsDefaultAppButtonProvider

public CmsDefaultAppButtonProvider()

Method Detail

createAppButton

public static com.vaadin.ui.Component createAppButton(CmsObject cms,
                                                      I_CmsWorkplaceAppConfiguration appConfig,
                                                      java.util.Locale locale)

Creates a properly styled button for the given app.

Parameters:

cms - the cms context

appConfig - the app configuration

locale - the locale

Returns:

the button component

createAppFolderButton

public static com.vaadin.ui.Component createAppFolderButton(CmsObject cms,
                                                            CmsAppCategoryNode node,
                                                            java.util.Locale locale)

Creates a properly styled button for the given app.

Parameters:

cms - the cms context

node - the node to display a buttom for

locale - the locale

Returns:

the button component (I_CmsFolderAppCategory)childNode.getCategory(), childNode.getAppConfigurations())

createAppFolderIconButton

public static com.vaadin.ui.Button createAppFolderIconButton(I_CmsFolderAppCategory appCat,
                                                             java.util.Locale locale)

Creates a properly styled button for the given app, without adding a click handler or checking visibility settings.

Parameters:

appCat - the app category

locale - the locale

Returns:

the button component

createAppIconButton

public static com.vaadin.ui.Button createAppIconButton(I_CmsWorkplaceAppConfiguration appConfig,
                                                       java.util.Locale locale)

Creates a properly styled button for the given app, without adding a click handler or checking visibility settings.

Parameters:

appConfig - the app configuration

locale - the locale

Returns:

the button component

createIconButton

public static com.vaadin.ui.Button createIconButton(java.lang.String name,
                                                    java.lang.String description,
                                                    com.vaadin.server.Resource icon)

Creates an icon button.

Parameters:

name - the name

description - the description

icon - the icon

Returns:

the created button

createIconButton

public static com.vaadin.ui.Button createIconButton(java.lang.String name,
                                                    java.lang.String description,
                                                    com.vaadin.server.Resource icon,
                                                    java.lang.String buttonStyle)

Creates an icon button.

Parameters:

name - the name

description - the description

icon - the icon

buttonStyle - the button style

Returns:

the created button

createAppButton

public com.vaadin.ui.Component createAppButton(I_CmsWorkplaceAppConfiguration appConfig)

Description copied from interface: I_CmsAppButtonProvider

Creates an app launcher button.

Specified by:

createAppButton in interface I_CmsAppButtonProvider

Parameters:

appConfig - the app configuration

Returns:

the button component

See Also:

I_CmsAppButtonProvider.createAppButton(org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration)

createAppFolderButton

public com.vaadin.ui.Component createAppFolderButton(CmsAppCategoryNode node)

Description copied from interface: I_CmsAppButtonProvider

Creates an app folder button.

Specified by:

createAppFolderButton in interface I_CmsAppButtonProvider

Parameters:

node - the folder configuration

Returns:

the button component

See Also:

I_CmsAppButtonProvider.createAppButton(org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration)