Package com.github.bordertech.wcomponents

Class WRow

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractContainer

com.github.bordertech.wcomponents.AbstractNamingContextContainer

com.github.bordertech.wcomponents.WRow

All Implemented Interfaces:

AjaxTarget, Container, Marginable, NamingContextable, SubordinateTarget, WComponent, WebComponent, Serializable

public class WRow
extends AbstractNamingContextContainer
implements AjaxTarget, SubordinateTarget, Marginable

This is a layout component, to which you add WColumn components. The widths of all the columns added to the row should total 100.

Author:

Ming Gao, Yiannis Paschalidis, Mark Reeves

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WRow.RowModel	Holds the extrinsic state information of the component.

Nested classes/interfaces inherited from class com.github.bordertech.wcomponents.AbstractWComponent

AbstractWComponent.WComponentRef

Field Summary

Fields inherited from interface com.github.bordertech.wcomponents.WComponent

DEFAULT_APPLICATION_ID, DEFAULT_INTERNAL_ID, DEFAULT_NO_ID, ID_CONTEXT_SEPERATOR, ID_FRAMEWORK_ASSIGNED_SEPERATOR, ID_VALIDATION_PATTERN

Constructor Summary

Constructors

Constructor	Description
WRow()	Creates a WRow.
WRow(int hgap)	Deprecated. use WRow(com.github.bordertech.wcomponents.Size)
WRow(Size space)	Create a WRow with the specified space between columns.

Method Summary

Modifier and Type	Method	Description
void	add(WColumn column)	Adds the given column as a child of this component.
protected WRow.RowModel	getComponentModel()	Returns the effective component model for this component.
int	getGap()	Deprecated.
int	getHgap()	Deprecated. use getGap()
Margin	getMargin()	Get the margin for the component, or null if not set.
protected WRow.RowModel	getOrCreateComponentModel()	Retrieves the model for this component so that it can be modified.
Size	getSpace()
protected WRow.RowModel	newComponentModel()	Creates a new Component model.
void	remove(WColumn column)	Removes the given column from this components list of children.
void	setMargin(Margin margin)	Set the margin for the component, or null for no margin.

Methods inherited from class com.github.bordertech.wcomponents.AbstractNamingContextContainer

getNamingContextId, isNamingContext, setNamingContext

Methods inherited from class com.github.bordertech.wcomponents.AbstractContainer

getChildAt, getChildCount, getChildren, getIndexOfChild

Methods inherited from class com.github.bordertech.wcomponents.AbstractWComponent

addHtmlClass, addHtmlClass, addNotify, afterPaint, assertAddSupported, beforePaint, createErrorDiagnostic, createErrorDiagnostic, forward, getAccessibleText, getAttribute, getBaseUrl, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, paintComponent, preparePaint, preparePaintComponent, removeAttribute, removeComponentModel, removeHtmlClass, removeHtmlClass, removeNotify, replaceWComponent, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFlag, setFocussed, setHidden, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showErrorIndicatorsForComponent, showWarningIndicators, showWarningIndicatorsForComponent, tidyUpUIContext, tidyUpUIContextForTree, toString, validate, validateComponent, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.bordertech.wcomponents.Container

getChildAt, getChildCount, getChildren, getIndexOfChild

Methods inherited from interface com.github.bordertech.wcomponents.WComponent

addHtmlClass, addHtmlClass, forward, getAccessibleText, getAttribute, getBaseUrl, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getParent, getTabIndex, getTag, getToolTip, handleRequest, hasTabIndex, invokeLater, isDefaultState, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, paint, preparePaint, removeAttribute, removeHtmlClass, removeHtmlClass, reset, serviceRequest, setAccessibleText, setAttribute, setEnvironment, setFocussed, setHtmlClass, setHtmlClass, setIdName, setInitialised, setLocked, setTag, setToolTip, setTrackingEnabled, setValidate, setVisible, showErrorIndicators, showWarningIndicators, tidyUpUIContextForTree, validate

Constructor Detail

WRow

public WRow()

Creates a WRow.

WRow

public WRow(Size space)

Create a WRow with the specified space between columns.

Parameters:

space - the space between columns in the row

WRow

@Deprecated
public WRow(int hgap)

Deprecated.

use WRow(com.github.bordertech.wcomponents.Size)

Creates a WRow with the specified attributes.

Parameters:

hgap - the space between the columns in the row

Method Detail

add

public void add(WColumn column)

Adds the given column as a child of this component.

Parameters:

column - the column to add.

remove

public void remove(WColumn column)

Removes the given column from this components list of children.

Parameters:

column - the column to remove

getHgap

@Deprecated
public int getHgap()

Deprecated.

use getGap()

Returns:

the horizontal space between the columns in the row, measured in pixels

getSpace

public Size getSpace()

Returns:

the horizontal space between the columns in the row

getGap

@Deprecated
public int getGap()

Deprecated.

Returns:

the space between the components added to the layout.

setMargin

public void setMargin(Margin margin)

Set the margin for the component, or null for no margin.

Specified by:

setMargin in interface Marginable

Parameters:

margin - the margin for the component

getMargin

public Margin getMargin()

Get the margin for the component, or null if not set.

Specified by:

getMargin in interface Marginable

Returns:

the margin for the component, or null if not set

newComponentModel

protected WRow.RowModel newComponentModel()

Creates a new Component model.

Overrides:

newComponentModel in class AbstractWComponent

Returns:

a new RowModel.

getComponentModel

protected WRow.RowModel getComponentModel()

Returns the effective component model for this component. Subclass may override this method to narrow the return type to their specific model type.

Overrides:

getComponentModel in class AbstractWComponent

Returns:

the effective component model

getOrCreateComponentModel

protected WRow.RowModel getOrCreateComponentModel()

Retrieves the model for this component so that it can be modified. If this method is called during request processing, and a session specific model does not yet exist, then a new model is created. Subclasses may override this method to narrow the return type to their specific model type.

Overrides:

getOrCreateComponentModel in class AbstractWComponent

Returns:

the model for this component