com.hybris.cockpitng.layout.impl.gridbag

Class GridBag<T>

java.lang.Object

com.hybris.cockpitng.layout.impl.gridbag.GridBag<T>

All Implemented Interfaces:

LayoutManager<T>

public class GridBag<T>
extends Object
implements LayoutManager<T>

Layout manager responsible for rendering elements in a grid.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CSS_PERCENT
static int	DEFAULT_COLUMN_NUMBER
static float	FULL_WIDTH

Fields inherited from interface com.hybris.cockpitng.layout.LayoutManager

DND_KEY

Constructor Summary

Constructors

Constructor and Description
GridBag()

Method Summary

Modifier and Type	Method and Description
protected int	calculateWidth(List<ElementPlacement<T>> placements)
protected Division	divideHorizontally(org.zkoss.zk.ui.Component parent, int startX, int startY, float cellWidth, List<ElementPlacement<T>> children, boolean iterate, String dndKey, BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)
protected Division	divideVertically(org.zkoss.zk.ui.Component parent, int startX, int startY, float cellWidth, List<ElementPlacement<T>> children, boolean iterate, String dndKey, BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)
protected Collection<ElementPlacement<T>>	fillEmptySpaces(List<ElementPlacement<T>> placements)
String	getColumnClass()
String	getDndKeyPrefix()
String	getDraggableHeaderClass()
String	getFillClass()
String	getRowClass()
String	getSlotClass()
protected boolean	overlaps(int x, int y, List<ElementPlacement<T>> positioned)
Collection<org.zkoss.zk.ui.HtmlBasedComponent>	positionElements(org.zkoss.zk.ui.Component parent, List<ElementPlacement<T>> elementPlacements, BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer) This method is responsible for creating the layout.
protected void	positionFloatingPlacements(List<ElementPlacement<T>> placements)
protected Collection<org.zkoss.zk.ui.HtmlBasedComponent>	renderFallbackDivision(org.zkoss.zk.ui.Component parent, List<ElementPlacement<T>> placements, int columnNumber, String dndKey, float cellWidth, BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)
protected org.zkoss.zk.ui.HtmlBasedComponent	renderSingleWidget(org.zkoss.zk.ui.Component parent, ElementPlacement<T> placement, String dndKey, float cellWidth, BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)
void	setColumnClass(String columnClass)
void	setDndKeyPrefix(String dndKeyPrefix)
void	setDraggableHeaderClass(String draggableHeaderClass)
void	setFillClass(String fillClass)
void	setRowClass(String rowClass)
void	setSlotClass(String slotClass)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COLUMN_NUMBER

public static final int DEFAULT_COLUMN_NUMBER

See Also:

Constant Field Values

FULL_WIDTH

public static final float FULL_WIDTH

See Also:

Constant Field Values

CSS_PERCENT

public static final String CSS_PERCENT

See Also:

Constant Field Values

Constructor Detail

GridBag

public GridBag()

Method Detail

positionElements

public Collection<org.zkoss.zk.ui.HtmlBasedComponent> positionElements(org.zkoss.zk.ui.Component parent,
                                                                       List<ElementPlacement<T>> elementPlacements,
                                                                       BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)

Description copied from interface: LayoutManager

This method is responsible for creating the layout.

Specified by:

positionElements in interface LayoutManager<T>

Parameters:

parent - Parent container for the elements

elementPlacements - List of elements to be positioned using the layout

renderer - function used for rendering a single occurrence of a widget

Returns:

Collection of components rendered by the manager. The elements may be used to post-process the components, for example to apply drag'n'drop specific implementation.

positionFloatingPlacements

protected void positionFloatingPlacements(List<ElementPlacement<T>> placements)

overlaps

protected boolean overlaps(int x,
                           int y,
                           List<ElementPlacement<T>> positioned)

fillEmptySpaces

protected Collection<ElementPlacement<T>> fillEmptySpaces(List<ElementPlacement<T>> placements)

calculateWidth

protected int calculateWidth(List<ElementPlacement<T>> placements)

divideHorizontally

protected Division divideHorizontally(org.zkoss.zk.ui.Component parent,
                                      int startX,
                                      int startY,
                                      float cellWidth,
                                      List<ElementPlacement<T>> children,
                                      boolean iterate,
                                      String dndKey,
                                      BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)

divideVertically

protected Division divideVertically(org.zkoss.zk.ui.Component parent,
                                    int startX,
                                    int startY,
                                    float cellWidth,
                                    List<ElementPlacement<T>> children,
                                    boolean iterate,
                                    String dndKey,
                                    BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)

renderFallbackDivision

protected Collection<org.zkoss.zk.ui.HtmlBasedComponent> renderFallbackDivision(org.zkoss.zk.ui.Component parent,
                                                                                List<ElementPlacement<T>> placements,
                                                                                int columnNumber,
                                                                                String dndKey,
                                                                                float cellWidth,
                                                                                BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)

renderSingleWidget

protected org.zkoss.zk.ui.HtmlBasedComponent renderSingleWidget(org.zkoss.zk.ui.Component parent,
                                                                ElementPlacement<T> placement,
                                                                String dndKey,
                                                                float cellWidth,
                                                                BiFunction<org.zkoss.zk.ui.Component,ElementPlacement<T>,org.zkoss.zk.ui.Component> renderer)

getDndKeyPrefix

public String getDndKeyPrefix()

setDndKeyPrefix

public void setDndKeyPrefix(String dndKeyPrefix)

getColumnClass

public String getColumnClass()

setColumnClass

public void setColumnClass(String columnClass)

getRowClass

public String getRowClass()

setRowClass

public void setRowClass(String rowClass)

getSlotClass

public String getSlotClass()

setSlotClass

public void setSlotClass(String slotClass)

getFillClass

public String getFillClass()

setFillClass

public void setFillClass(String fillClass)

getDraggableHeaderClass

public String getDraggableHeaderClass()

setDraggableHeaderClass

public void setDraggableHeaderClass(String draggableHeaderClass)