com.hybris.cockpitng.util

Class WidgetTreeUIUtils

java.lang.Object

com.hybris.cockpitng.util.WidgetTreeUIUtils

public final class WidgetTreeUIUtils
extends Object

Useful utility method to work with component tree representing the widget tree structure.

Method Summary

Modifier and Type	Method and Description
static org.zkoss.zk.ui.Component	getFirstWidgetChild(org.zkoss.zk.ui.Component component)
static Widgetchildren	getParentWidgetchildren(org.zkoss.zk.ui.Component comp)
static WidgetContainer	getParentWidgetContainer(org.zkoss.zk.ui.Component comp) Returns the first parent component being an instance of WidgetContainer, i.e.
static Widgetslot	getParentWidgetslot(org.zkoss.zk.ui.Component comp)
static Widget	getVisibleWidget(Widgetslot parent, String childSlotId, Predicate<Widget> visibilityCheck) Gets a visible widget on slot with provided id.
static List<Widget>	getVisibleWidgets(Widgetslot widgetslot, Predicate<Widget> visibilityCheck) Returns a list of widgets that are children of the given widget slot that are visible according to visibilityCheck method.
static void	updateRootWidget(Widgetslot widgetComp, boolean resetWidget)

Methods inherited from class java.lang.Object

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

Method Detail

getParentWidgetContainer

public static WidgetContainer getParentWidgetContainer(org.zkoss.zk.ui.Component comp)

Returns the first parent component being an instance of WidgetContainer, i.e. either a Widgetslot or a Widgetchildren, whatever comes first.

getParentWidgetslot

public static Widgetslot getParentWidgetslot(org.zkoss.zk.ui.Component comp)

getParentWidgetchildren

public static Widgetchildren getParentWidgetchildren(org.zkoss.zk.ui.Component comp)

getFirstWidgetChild

public static org.zkoss.zk.ui.Component getFirstWidgetChild(org.zkoss.zk.ui.Component component)

updateRootWidget

public static void updateRootWidget(Widgetslot widgetComp,
                                    boolean resetWidget)

getVisibleWidget

public static Widget getVisibleWidget(Widgetslot parent,
                                      String childSlotId,
                                      Predicate<Widget> visibilityCheck)

Gets a visible widget on slot with provided id.

Parameters:

parent - parent slot

childSlotId - id of slot to be checked

visibilityCheck - a predicate to check whether a widget is visible

Returns:

widget on provided slot

getVisibleWidgets

public static List<Widget> getVisibleWidgets(Widgetslot widgetslot,
                                             Predicate<Widget> visibilityCheck)

Returns a list of widgets that are children of the given widget slot that are visible according to visibilityCheck method.

Parameters:

widgetslot - Widgetslot for which the visible widgets should be found

Returns:

List of Widget