Package com.hybris.cockpitng.widgets.common.dynamicforms.impl.visitors

Class TabsVisitor

java.lang.Object

com.hybris.cockpitng.widgets.common.dynamicforms.impl.visitors.AbstractComponentsVisitor<org.zkoss.zul.Tab,DynamicTab>

com.hybris.cockpitng.widgets.common.dynamicforms.impl.visitors.TabsVisitor

All Implemented Interfaces:

ComponentsVisitor

public class TabsVisitor
extends AbstractComponentsVisitor<org.zkoss.zul.Tab,DynamicTab>

Visitor of Tab from UI elements. Uses as a configuration DynamicForms.getTab()

Field Summary

Fields inherited from interface com.hybris.cockpitng.widgets.common.dynamicforms.ComponentsVisitor

COMPONENT_CTX, MODEL_ROOT, NULL

Constructor Summary

Constructors

Constructor	Description
TabsVisitor()

Method Summary

Modifier and Type	Method	Description
protected void	applyDisabledIf(java.util.Collection<org.zkoss.zul.Tab> zkTabs, DynamicTab dynamicTab, java.lang.Object target)
protected void	applyVisibleIf(java.util.Collection<org.zkoss.zul.Tab> zkTabs, DynamicTab dynamicTab, java.lang.Object target)
protected boolean	canHandle(org.zkoss.zk.ui.Component component)	Decides if component can be handled by the visitor.
protected java.lang.String	getComponentKey(org.zkoss.zul.Tab component)	Gets component's name key which is used to map components with dynamic forms through AbstractDynamicElement.getQualifier().
protected java.util.List<DynamicTab>	getDynamicElements()	Extracts elements of type from DynamicForms.
protected boolean	goToFirstAccessibleTab(java.util.Collection<org.zkoss.zul.Tab> gotoZkTabs)	Goes to first tab which is not disabled or hidden
protected boolean	gotoTabId(java.lang.String tabId)	Opens a tab with given id.
protected void	gotoTabIdOrFirstAccessibleTab(java.util.Collection<org.zkoss.zul.Tab> zkTabs, DynamicTab dynamicTab)	Goes to tab with id defined in DynamicTab.getFallbackGotoTabId()
protected boolean	isGoToTab(DynamicTab element, java.lang.Object target)	Checks configuration from DynamicTab.gotoTabIf against target object.
protected void	setSelectedTab(org.zkoss.zul.Tab zkTab)	Sets selected tab and sends event.
protected void	visitComponents(DynamicTab dynamicTab, java.lang.Object target, boolean initial)	Visits components for dynamic element.

Methods inherited from class com.hybris.cockpitng.widgets.common.dynamicforms.impl.visitors.AbstractComponentsVisitor

canChangeProperty, canReadProperty, cleanUp, cleanUpInternal, getComponentKeyComponentsMap, getDataType, getDefaultScriptingConfig, getDynamicForms, getElementQualifierKey, getExpressionEvaluator, getPathToAttributeInModel, getPathToAttributeInModel, getPermissionFacade, getTargetObject, getTypeCode, getTypeFacade, getWidgetInstanceManager, initialize, isDisabled, isVisible, register, setExpressionEvaluator, setPermissionFacade, setTypeFacade, unRegister

Methods inherited from class java.lang.Object

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

Constructor Detail

TabsVisitor

public TabsVisitor()

Method Detail

canHandle

protected boolean canHandle(org.zkoss.zk.ui.Component component)

Description copied from class: AbstractComponentsVisitor

Decides if component can be handled by the visitor.

Specified by:

canHandle in class AbstractComponentsVisitor<org.zkoss.zul.Tab,DynamicTab>

Parameters:

component - component to accept.

Returns:

true if components should be accepted by visitor.

getComponentKey

protected java.lang.String getComponentKey(org.zkoss.zul.Tab component)

Description copied from class: AbstractComponentsVisitor

Gets component's name key which is used to map components with dynamic forms through AbstractDynamicElement.getQualifier().

Specified by:

getComponentKey in class AbstractComponentsVisitor<org.zkoss.zul.Tab,DynamicTab>

Parameters:

component - component which id should be returned.

Returns:

extracted key of a component.

getDynamicElements

protected java.util.List<DynamicTab> getDynamicElements()

Description copied from class: AbstractComponentsVisitor

Extracts elements of type from DynamicForms.

Specified by:

getDynamicElements in class AbstractComponentsVisitor<org.zkoss.zul.Tab,DynamicTab>

Returns:

list of to use in configuration.

visitComponents

protected void visitComponents(DynamicTab dynamicTab,
                               java.lang.Object target,
                               boolean initial)

Description copied from class: AbstractComponentsVisitor

Visits components for dynamic element.

Specified by:

visitComponents in class AbstractComponentsVisitor<org.zkoss.zul.Tab,DynamicTab>

Parameters:

dynamicTab - dynamic forms element configuration.

target - currently displayed object.

initial - flag which says if this is initial visit before any interaction with user.

gotoTabId

protected boolean gotoTabId(java.lang.String tabId)

Opens a tab with given id. The tab is search in collected components.

Parameters:

tabId - tab id.

Returns:

true if operation was successful.

gotoTabIdOrFirstAccessibleTab

protected void gotoTabIdOrFirstAccessibleTab(java.util.Collection<org.zkoss.zul.Tab> zkTabs,
                                             DynamicTab dynamicTab)

Goes to tab with id defined in DynamicTab.getFallbackGotoTabId()

Parameters:

zkTabs - all tabs in the tabBox

dynamicTab - dynamicForms tab config.

goToFirstAccessibleTab

protected boolean goToFirstAccessibleTab(java.util.Collection<org.zkoss.zul.Tab> gotoZkTabs)

Goes to first tab which is not disabled or hidden

Parameters:

gotoZkTabs - all tabs in the tabBox

Returns:

true if operation was successful.

applyVisibleIf

protected void applyVisibleIf(java.util.Collection<org.zkoss.zul.Tab> zkTabs,
                              DynamicTab dynamicTab,
                              java.lang.Object target)

applyDisabledIf

protected void applyDisabledIf(java.util.Collection<org.zkoss.zul.Tab> zkTabs,
                               DynamicTab dynamicTab,
                               java.lang.Object target)

isGoToTab

protected boolean isGoToTab(DynamicTab element,
                            java.lang.Object target)

Checks configuration from DynamicTab.gotoTabIf against target object.

Parameters:

element - element of configuration

target - target object

Returns:

true if should go to tab with id DynamicTab.gotoTabId

setSelectedTab

protected void setSelectedTab(org.zkoss.zul.Tab zkTab)

Sets selected tab and sends event.

Parameters:

zkTab - selected tab