Package com.saperion.ngc.iform.layout

Interface FormLayout

All Known Implementing Classes:

AbstractFormLayout, FormLayout1, FormLayout10, FormLayout11, FormLayout12, FormLayout13, FormLayout14, FormLayout15, FormLayout16, FormLayout17, FormLayout18, FormLayout19, FormLayout2, FormLayout20, FormLayout21, FormLayout3, FormLayout4, FormLayout5, FormLayout6, FormLayout7, FormLayout8, FormLayout9, PaneLayout

public interface FormLayout

Represents a layout option for a form. Based on the 18 predefined layouts in QBE Designer.

Method Summary

Modifier and Type	Method	Description
void	addChildToFrame(org.zkoss.zk.ui.Component child, int frameId)	Adds a child component to the specified frame.
void	finishLayout()	Indicates that all children have been added.
org.zkoss.zk.ui.HtmlBasedComponent	getFrame(int frameId)	Returns the frame with the specified ID.
int	getType()	Returns the type of the layout.
boolean	isTabPane(java.lang.Integer id)	Check, if the element is a tab pane.
void	setFrameDimensions(int frameId, com.saperion.ngc.iform.xml.PosType framePosition)	Sets the dimensions of the specified frame.
void	setStoredSizes(java.util.Map<java.lang.Integer,AreaSize> sizes)	Sets the sizes of the layout areas that were stored in the backend-configuration.

Method Detail

getType

int getType()

Returns the type of the layout.

Returns:

type

addChildToFrame

void addChildToFrame(org.zkoss.zk.ui.Component child,
                     int frameId)

Adds a child component to the specified frame.

Parameters:

child - child to add

frameId - frame id

setFrameDimensions

void setFrameDimensions(int frameId,
                        com.saperion.ngc.iform.xml.PosType framePosition)

Sets the dimensions of the specified frame.

Parameters:

frameId - id of the frame

framePosition - frame position

finishLayout

void finishLayout()
           throws FormRenderException

Indicates that all children have been added. The layout will perform finishing operations like size calculations.

Throws:

FormRenderException - when the layout process fails

isTabPane

boolean isTabPane(java.lang.Integer id)

Check, if the element is a tab pane.

Parameters:

id - ID

Returns:

True, if tab pane

getFrame

org.zkoss.zk.ui.HtmlBasedComponent getFrame(int frameId)

Returns the frame with the specified ID.

Parameters:

frameId - frame id

Returns:

frame component

setStoredSizes

void setStoredSizes(java.util.Map<java.lang.Integer,AreaSize> sizes)

Sets the sizes of the layout areas that were stored in the backend-configuration.

Parameters:

sizes - area sizes from backend