org.osivia.portal.api.taskbar

Interface TaskbarFactory

public interface TaskbarFactory

Taskbar factory.

Author:

Cédric Krommenhoek

Method Summary

Methods

Modifier and Type	Method and Description
TaskbarItem	createCmsTaskbarItem(String id, String key, String icon, String documentType) Create CMS taskbar item.
TaskbarItem	createStapledTaskbarItem(String id, String key, String icon, PanelPlayer player) Create stapled taskbar item.
TaskbarItem	createStapledTaskbarItem(String id, String key, String icon, String template) Create stapled taskbar item.
TaskbarItems	createTaskbarItems() Create taskbar items.
TaskbarTask	createTaskbarTask(String id, String title, String icon, String path, String documentType, boolean disabled) Create taskbar task.
TaskbarTask	createTaskbarTask(TaskbarItem item, String path, boolean disabled) Create taskbar task.
TaskbarItem	createTransversalTaskbarItem(String id, String key, String icon, PanelPlayer player) Create transversal taskbar item.
void	hide(TaskbarItem item, boolean hidden) Hide taskbar item.
void	preset(TaskbarItem item, boolean preset, Integer order) Preset taskbar item.
void	restrict(TaskbarItem item, TaskbarItemRestriction restriction) Restrict taskbar item access.
void	setExecutor(TaskbarItem item, TaskbarItemExecutor executor) Set taskbar item executor.

Method Detail

createTaskbarItems

TaskbarItems createTaskbarItems()

Create taskbar items.

Returns:

taskbar items

createTransversalTaskbarItem

TaskbarItem createTransversalTaskbarItem(String id,
                                       String key,
                                       String icon,
                                       PanelPlayer player)

Create transversal taskbar item.

Parameters:

id - taskbar item identifier

key - taskbar item internationalization key

icon - taskbar item icon

player - player

Returns:

taskbar item

createStapledTaskbarItem

TaskbarItem createStapledTaskbarItem(String id,
                                   String key,
                                   String icon,
                                   PanelPlayer player)

Create stapled taskbar item.

Parameters:

id - taskbar item identifier

key - taskbar item internationalization key

icon - taskbar item icon

player - player

Returns:

taskbar item

createStapledTaskbarItem

TaskbarItem createStapledTaskbarItem(String id,
                                   String key,
                                   String icon,
                                   String template)

Create stapled taskbar item.

Parameters:

id - taskbar item identifier

key - taskbar item internationalization key

icon - taskbar item icon

template - template

Returns:

taskbar item

createCmsTaskbarItem

TaskbarItem createCmsTaskbarItem(String id,
                               String key,
                               String icon,
                               String documentType)

Create CMS taskbar item.

Parameters:

id - taskbar item identifier

key - taskbar item internationalization key

icon - taskbar item icon

documentType - taskbar item document type

Returns:

taskbar item

hide

void hide(TaskbarItem item,
        boolean hidden)

Hide taskbar item.

Parameters:

item - taskbar item

hidden - hidden indicator

restrict

void restrict(TaskbarItem item,
            TaskbarItemRestriction restriction)

Restrict taskbar item access.

Parameters:

item - taskbar item

restriction - restriction

preset

void preset(TaskbarItem item,
          boolean preset,
          Integer order)

Preset taskbar item.

Parameters:

item - taskbar item

preset - preset indicator

order - taskbar preset order, may be null to keep default value

setExecutor

void setExecutor(TaskbarItem item,
               TaskbarItemExecutor executor)

Set taskbar item executor.

Parameters:

item - taskbar item

executor - executor

createTaskbarTask

TaskbarTask createTaskbarTask(TaskbarItem item,
                            String path,
                            boolean disabled)

Create taskbar task.

Parameters:

item - taskbar item

path - CMS path

disabled - disabled indicator

Returns:

taskbar task

createTaskbarTask

TaskbarTask createTaskbarTask(String id,
                            String title,
                            String icon,
                            String path,
                            String documentType,
                            boolean disabled)

Create taskbar task.

Parameters:

id - identifier

title - title

icon - icon

path - CMS path

documentType - document type

disabled - disabled indicator

Returns:

taskbar task