Package com.github.bordertech.wcomponents

Class WColumnLayout

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractContainer

com.github.bordertech.wcomponents.AbstractNamingContextContainer

com.github.bordertech.wcomponents.WColumnLayout

All Implemented Interfaces:

Container, NamingContextable, WComponent, WebComponent, Serializable

public class WColumnLayout
extends AbstractNamingContextContainer

This component is used to group together two components into a two column (left and right) display.

A common usage would be two wrap two WFieldLayout instances into two columns.

Since:

1.0.0

Author:

Adam Millard

See Also:

Serialized Form

Nested Class Summary

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
WColumnLayout()	Creates a column layout with no heading.
WColumnLayout(WHeading heading)	Creates a column layout with the given heading.
WColumnLayout(String heading)	Creates a column layout with the given section heading.

Method Summary

Modifier and Type	Method	Description
WColumn	getLeftColumn()	For the DIMAv2 theme and above, this can be used to change the left column attributes.
WColumn	getRightColumn()	For the DIMAv2 theme and above, this can be used to change the right column attributes.
boolean	hasLeftContent()
boolean	hasRightContent()
void	setLeftColumn(WComponent content)	Sets the left column content.
void	setLeftColumn(WHeading heading, WComponent content)	Sets the left column content.
void	setLeftColumn(String heading, WComponent content)	Sets the left column content.
void	setRightColumn(WComponent content)	Sets the right column content.
void	setRightColumn(WHeading heading, WComponent content)	Sets the right column content.
void	setRightColumn(String heading, WComponent content)	Sets the right column content.

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, getComponentModel, getDefaultModel, getEnvironment, getHeaders, getHtmlClass, getHtmlClasses, getId, getIdName, getInternalId, getLabel, getName, getOrCreateComponentModel, getParent, getScratchMap, getTabIndex, getTag, getTemplate, getTemplateMarkUp, getToolTip, handleRequest, hasNoComponentModel, hasTabIndex, initialiseComponentModel, invokeLater, invokeLaters, isDebugStructure, isDefaultState, isFlagSet, isHidden, isInitialised, isLocked, isTracking, isTrackingEnabled, isValidate, isVisible, newComponentModel, 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

WColumnLayout

public WColumnLayout()

Creates a column layout with no heading.

WColumnLayout

public WColumnLayout(String heading)

Creates a column layout with the given section heading.

Parameters:

heading - the heading text.

WColumnLayout

public WColumnLayout(WHeading heading)

Creates a column layout with the given heading.

Parameters:

heading - the heading.

Method Detail

setLeftColumn

public void setLeftColumn(WComponent content)

Sets the left column content.

Parameters:

content - the content.

setLeftColumn

public void setLeftColumn(String heading,
                          WComponent content)

Sets the left column content.

Parameters:

heading - the column heading text.

content - the content.

setLeftColumn

public void setLeftColumn(WHeading heading,
                          WComponent content)

Sets the left column content.

Parameters:

heading - the column heading.

content - the content.

setRightColumn

public void setRightColumn(WComponent content)

Sets the right column content.

Parameters:

content - the content.

setRightColumn

public void setRightColumn(String heading,
                           WComponent content)

Sets the right column content.

Parameters:

heading - the column heading text.

content - the content.

setRightColumn

public void setRightColumn(WHeading heading,
                           WComponent content)

Sets the right column content.

Parameters:

heading - the column heading.

content - the content.

getLeftColumn

public WColumn getLeftColumn()

For the DIMAv2 theme and above, this can be used to change the left column attributes.

Returns:

the left column.

getRightColumn

public WColumn getRightColumn()

For the DIMAv2 theme and above, this can be used to change the right column attributes.

Returns:

the right column.

hasLeftContent

public boolean hasLeftContent()

Returns:

true if there is content in the left column.

hasRightContent

public boolean hasRightContent()

Returns:

true if there is content in the right column.