Package com.hybris.cockpitng.widgets.controller

Class FlexibleLayoutWidgetController

java.lang.Object

org.zkoss.zk.ui.event.GenericEventListener

org.zkoss.zk.ui.util.GenericComposer<T>

org.zkoss.zk.ui.util.GenericAutowireComposer<T>

org.zkoss.zk.ui.util.GenericForwardComposer<org.zkoss.zk.ui.Component>

com.hybris.cockpitng.util.ViewAnnotationAwareComposer

com.hybris.cockpitng.util.DefaultWidgetController

com.hybris.cockpitng.widgets.controller.FlexibleLayoutWidgetController

All Implemented Interfaces:

WidgetController, WidgetDragAndDropAware, WidgetInstanceManagerAware, java.io.Serializable, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.event.SerializableEventListener, org.zkoss.zk.ui.util.ComponentActivationListener, org.zkoss.zk.ui.util.ComponentCloneListener, org.zkoss.zk.ui.util.Composer<org.zkoss.zk.ui.Component>, org.zkoss.zk.ui.util.ComposerExt<org.zkoss.zk.ui.Component>

public class FlexibleLayoutWidgetController
extends DefaultWidgetController

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	COMPONENT_CLOSE_SIDERBAR_BUTTON
protected static java.lang.String	COMPONENT_COLLAPSE_BUTTON
protected static java.lang.String	COMPONENT_FLEXIBLE_LAYOUT_OVERLAY
protected static java.lang.String	EVENT_ON_LOOPBACK	Deprecated, for removal: This API element is subject to removal in a future version. since 6.5
protected static java.lang.String	MODEL_SIDEBAR_FORCE_STATE
protected static java.lang.String	MODEL_SIDEBAR_RESPONSIVE_BREAKPOINT
protected static java.lang.String	MODEL_SIDEBAR_STATE
protected static java.lang.String	SCLASS_SIDEBAR_CLOSED
protected static java.lang.String	SCLASS_SIDEBAR_COLLAPSED
protected static java.lang.String	SCLASS_SIDEBAR_COLLAPSIBLE
protected static java.lang.String	SCLASS_SIDEBAR_LEFT
protected static java.lang.String	SCLASS_SIDEBAR_OPENED
protected static java.lang.String	SCLASS_SIDEBAR_OVERLAP
protected static java.lang.String	SCLASS_SIDEBAR_OVERLAP_ON_HOVER
protected static java.lang.String	SCLASS_SIDEBAR_RESPONSIVE
protected static java.lang.String	SCLASS_SIDEBAR_RIGHT
protected static java.lang.String	SETTING_OVERLAP_ON_HOVER
protected static java.lang.String	SETTING_SIDEBAR_COLLAPSED
protected static java.lang.String	SETTING_SIDEBAR_COLLAPSIBLE
protected static java.lang.String	SETTING_SIDEBAR_OVERLAP
protected static java.lang.String	SETTING_SIDEBAR_POSITION
protected static java.lang.String	SETTING_SIDEBAR_STATE
protected static java.lang.String	SIDEBAR_POSITION_LEFT
protected static java.lang.String	SIDEBAR_POSITION_RIGHT
static java.lang.String	SIDEBAR_STATE_CLOSED
static java.lang.String	SIDEBAR_STATE_OPENED
protected static java.lang.String	SOCKET_INPUT_CLOSE
protected static java.lang.String	SOCKET_INPUT_OPEN
protected static java.lang.String	SOCKET_INPUT_RESPONSIVE_BREAKPOINT
protected static java.lang.String	SOCKET_INPUT_SET_STATE
protected static java.lang.String	SOCKET_INPUT_TOGGLE
protected static java.lang.String	SOCKET_INPUT_TOGGLE_COLLAPSED
protected static java.lang.String	SOCKET_OUTPUT_STATE_CHANGED

Fields inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

_separator, application, applicationScope, arg, componentScope, desktop, desktopScope, execution, page, pageScope, param, requestScope, self, session, sessionScope, spaceOwner, spaceScope

Fields inherited from class org.zkoss.zk.ui.util.GenericComposer

_applied

Constructor Summary

Constructors

Constructor	Description
FlexibleLayoutWidgetController()

Method Summary

Modifier and Type	Method	Description
void	closeSidebar()
protected org.zkoss.zul.Button	getCloseSidebarButton()
protected org.zkoss.zul.Div	getContents()
org.zkoss.zul.Div	getFlexlayoutOverlay()
protected org.zkoss.zul.Div	getRootpane()
protected org.zkoss.zul.Div	getSidebar()
protected java.lang.Object	getSidebarResponsiveBreakpoint()
protected java.lang.String	getSidebarState()
void	initialize(org.zkoss.zk.ui.Component comp)	Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc.
protected boolean	isSidebarCollapsed()
protected boolean	isSidebarCollapsible()
protected boolean	isSidebarForceState()
protected boolean	isSidebarResponsive()
protected void	notifySidebarState()
void	openSidebar()
protected void	postponedContentsInvalidation()
protected void	postponedStateSend(org.zkoss.zk.ui.Component parent)
protected void	restoreResponsivenessImmediately()
protected void	restoreSidebarCollapsedImmediately()
protected void	restoreStateImmediately()
protected void	setSidebarCollapsed(boolean collapsed)
protected void	setSidebarCollapsedImmediately(boolean collapsed)
protected void	setSidebarForceState(boolean forceOpen)
void	setSidebarResponsive(java.lang.Object breakpoint)
protected void	setSidebarResponsiveImmediately(java.lang.Object breakpoint)
void	setSidebarState(java.lang.String state)
protected void	setSidebarStateImmediately(java.lang.String state)
protected boolean	shouldSetState()
void	toggleCollapsedSidebar()
void	toggleSidebar()

Methods inherited from class com.hybris.cockpitng.util.DefaultWidgetController

doAfterCompose, doBeforeCompose, doBeforeComposeChildren, executeOperation, getDragAndDropStrategy, getLabel, getLabel, getModel, getValue, getWidgetDragAndDropStrategyRepository, getWidgetInstanceManager, getWidgetRoot, getWidgetSettings, getWidgetslot, getWidgetTitle, getWidgetUtils, initDragAndDropAwareness, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, initWidgetSetting, invokeListenerMethod, onSocketInput, preInitialize, sendOutput, sendOutputAfterOperation, sendOutputAfterOperation, sendOutputAfterOperation, setValue, setWidgetInstanceManager, setWidgetTitle

Methods inherited from class com.hybris.cockpitng.util.ViewAnnotationAwareComposer

scanEventListeners

Methods inherited from class org.zkoss.zk.ui.util.GenericAutowireComposer

alert, didActivate, getPage, willClone, willPassivate

Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

doCatch, doFinally

Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

bindComponent, getController, onEvent, unbindComponent

Methods inherited from class java.lang.Object

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

Field Detail

SIDEBAR_STATE_OPENED

public static final java.lang.String SIDEBAR_STATE_OPENED

See Also:

Constant Field Values

SIDEBAR_STATE_CLOSED

public static final java.lang.String SIDEBAR_STATE_CLOSED

See Also:

Constant Field Values

SOCKET_INPUT_CLOSE

protected static final java.lang.String SOCKET_INPUT_CLOSE

See Also:

Constant Field Values

SOCKET_INPUT_OPEN

protected static final java.lang.String SOCKET_INPUT_OPEN

See Also:

Constant Field Values

SOCKET_INPUT_TOGGLE

protected static final java.lang.String SOCKET_INPUT_TOGGLE

See Also:

Constant Field Values

SOCKET_INPUT_TOGGLE_COLLAPSED

protected static final java.lang.String SOCKET_INPUT_TOGGLE_COLLAPSED

See Also:

Constant Field Values

SOCKET_INPUT_SET_STATE

protected static final java.lang.String SOCKET_INPUT_SET_STATE

See Also:

Constant Field Values

SOCKET_INPUT_RESPONSIVE_BREAKPOINT

protected static final java.lang.String SOCKET_INPUT_RESPONSIVE_BREAKPOINT

See Also:

Constant Field Values

SOCKET_OUTPUT_STATE_CHANGED

protected static final java.lang.String SOCKET_OUTPUT_STATE_CHANGED

See Also:

Constant Field Values

EVENT_ON_LOOPBACK

@Deprecated(since="6.5",
            forRemoval=true)
protected static final java.lang.String EVENT_ON_LOOPBACK

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.5

See Also:

UITools.EVENT_ON_LOOPBACK, UITools.postponeExecution(Component, Executable), Constant Field Values

COMPONENT_COLLAPSE_BUTTON

protected static final java.lang.String COMPONENT_COLLAPSE_BUTTON

See Also:

Constant Field Values

COMPONENT_CLOSE_SIDERBAR_BUTTON

protected static final java.lang.String COMPONENT_CLOSE_SIDERBAR_BUTTON

See Also:

Constant Field Values

COMPONENT_FLEXIBLE_LAYOUT_OVERLAY

protected static final java.lang.String COMPONENT_FLEXIBLE_LAYOUT_OVERLAY

See Also:

Constant Field Values

SIDEBAR_POSITION_LEFT

protected static final java.lang.String SIDEBAR_POSITION_LEFT

See Also:

Constant Field Values

SIDEBAR_POSITION_RIGHT

protected static final java.lang.String SIDEBAR_POSITION_RIGHT

See Also:

Constant Field Values

SCLASS_SIDEBAR_OPENED

protected static final java.lang.String SCLASS_SIDEBAR_OPENED

See Also:

Constant Field Values

SCLASS_SIDEBAR_COLLAPSED

protected static final java.lang.String SCLASS_SIDEBAR_COLLAPSED

See Also:

Constant Field Values

SCLASS_SIDEBAR_COLLAPSIBLE

protected static final java.lang.String SCLASS_SIDEBAR_COLLAPSIBLE

See Also:

Constant Field Values

SCLASS_SIDEBAR_CLOSED

protected static final java.lang.String SCLASS_SIDEBAR_CLOSED

See Also:

Constant Field Values

SCLASS_SIDEBAR_RESPONSIVE

protected static final java.lang.String SCLASS_SIDEBAR_RESPONSIVE

See Also:

Constant Field Values

SETTING_SIDEBAR_STATE

protected static final java.lang.String SETTING_SIDEBAR_STATE

See Also:

Constant Field Values

SETTING_SIDEBAR_POSITION

protected static final java.lang.String SETTING_SIDEBAR_POSITION

See Also:

Constant Field Values

SETTING_SIDEBAR_COLLAPSED

protected static final java.lang.String SETTING_SIDEBAR_COLLAPSED

See Also:

Constant Field Values

SETTING_SIDEBAR_COLLAPSIBLE

protected static final java.lang.String SETTING_SIDEBAR_COLLAPSIBLE

See Also:

Constant Field Values

SETTING_OVERLAP_ON_HOVER

protected static final java.lang.String SETTING_OVERLAP_ON_HOVER

See Also:

Constant Field Values

SETTING_SIDEBAR_OVERLAP

protected static final java.lang.String SETTING_SIDEBAR_OVERLAP

See Also:

Constant Field Values

SCLASS_SIDEBAR_LEFT

protected static final java.lang.String SCLASS_SIDEBAR_LEFT

See Also:

Constant Field Values

SCLASS_SIDEBAR_RIGHT

protected static final java.lang.String SCLASS_SIDEBAR_RIGHT

See Also:

Constant Field Values

SCLASS_SIDEBAR_OVERLAP_ON_HOVER

protected static final java.lang.String SCLASS_SIDEBAR_OVERLAP_ON_HOVER

See Also:

Constant Field Values

SCLASS_SIDEBAR_OVERLAP

protected static final java.lang.String SCLASS_SIDEBAR_OVERLAP

See Also:

Constant Field Values

MODEL_SIDEBAR_STATE

protected static final java.lang.String MODEL_SIDEBAR_STATE

See Also:

Constant Field Values

MODEL_SIDEBAR_FORCE_STATE

protected static final java.lang.String MODEL_SIDEBAR_FORCE_STATE

See Also:

Constant Field Values

MODEL_SIDEBAR_RESPONSIVE_BREAKPOINT

protected static final java.lang.String MODEL_SIDEBAR_RESPONSIVE_BREAKPOINT

See Also:

Constant Field Values

Constructor Detail

FlexibleLayoutWidgetController

public FlexibleLayoutWidgetController()

Method Detail

initialize

public void initialize(org.zkoss.zk.ui.Component comp)

Description copied from class: DefaultWidgetController

Override this method to do initialization stuff for your widget, like initialize widget settings, restore view state from viewmodel, etc. This method will be invoked by DefaultWidgetController.doAfterCompose(Component) everytime your widget view is created. See GenericForwardComposer.doAfterCompose(Component) for more details.

Overrides:

initialize in class DefaultWidgetController

postponedStateSend

protected void postponedStateSend(org.zkoss.zk.ui.Component parent)

toggleSidebar

public void toggleSidebar()

notifySidebarState

protected void notifySidebarState()

openSidebar

public void openSidebar()

closeSidebar

public void closeSidebar()

setSidebarState

public void setSidebarState(java.lang.String state)

restoreStateImmediately

protected void restoreStateImmediately()

setSidebarStateImmediately

protected void setSidebarStateImmediately(java.lang.String state)

getSidebarState

protected java.lang.String getSidebarState()

restoreSidebarCollapsedImmediately

protected void restoreSidebarCollapsedImmediately()

isSidebarCollapsed

protected boolean isSidebarCollapsed()

setSidebarCollapsed

protected void setSidebarCollapsed(boolean collapsed)

setSidebarCollapsedImmediately

protected void setSidebarCollapsedImmediately(boolean collapsed)

postponedContentsInvalidation

protected void postponedContentsInvalidation()

shouldSetState

protected boolean shouldSetState()

isSidebarForceState

protected boolean isSidebarForceState()

setSidebarForceState

protected void setSidebarForceState(boolean forceOpen)

isSidebarCollapsible

protected boolean isSidebarCollapsible()

toggleCollapsedSidebar

public void toggleCollapsedSidebar()

restoreResponsivenessImmediately

protected void restoreResponsivenessImmediately()

getSidebarResponsiveBreakpoint

protected java.lang.Object getSidebarResponsiveBreakpoint()

isSidebarResponsive

protected boolean isSidebarResponsive()

setSidebarResponsive

public void setSidebarResponsive(java.lang.Object breakpoint)

setSidebarResponsiveImmediately

protected void setSidebarResponsiveImmediately(java.lang.Object breakpoint)

getRootpane

protected org.zkoss.zul.Div getRootpane()

getSidebar

protected org.zkoss.zul.Div getSidebar()

getContents

protected org.zkoss.zul.Div getContents()

getCloseSidebarButton

protected org.zkoss.zul.Button getCloseSidebarButton()

getFlexlayoutOverlay

public org.zkoss.zul.Div getFlexlayoutOverlay()