Package com.github.bordertech.wcomponents

Class WColumn

java.lang.Object

com.github.bordertech.wcomponents.AbstractWComponent

com.github.bordertech.wcomponents.AbstractContainer

com.github.bordertech.wcomponents.AbstractNamingContextContainer

com.github.bordertech.wcomponents.AbstractMutableContainer

com.github.bordertech.wcomponents.WColumn

All Implemented Interfaces:

AjaxTarget, Container, MutableContainer, NamingContextable, WComponent, WebComponent, Serializable

public class WColumn
extends AbstractMutableContainer
implements AjaxTarget

This is a layout component to be used in conjunction with WRow.

Since:

1.0.0

Author:

Ming Gao, Mark Reeves

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WColumn.Alignment	Describes how content within a column should be aligned.
static class	WColumn.ColumnModel	Holds the extrinsic state information of a WColumn.

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
WColumn()	Creates a WColumn with undefined width.
WColumn(int widthPercentage)	Creates a WColumn with the width specified as a percentage of the total available width.

Method Summary

Modifier and Type	Method	Description
WColumn.Alignment	getAlignment()
protected WColumn.ColumnModel	getComponentModel()	Returns the effective component model for this component.
protected WColumn.ColumnModel	getOrCreateComponentModel()	Retrieves the model for this component so that it can be modified.
int	getWidth()
protected WColumn.ColumnModel	newComponentModel()	Creates a new component model appropriate for this component.
void	setAlignment(WColumn.Alignment alignment)
void	setWidth(int widthPercent)	Sets the relative column width, measured as a percentage of the total available width.
String	toString()	Creates a String representation of this component; usually for debugging purposes.

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

add, add, remove, removeAll

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, 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.NamingContextable

getNamingContextId, isNamingContext

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

WColumn

public WColumn()

Creates a WColumn with undefined width.

WColumn

public WColumn(int widthPercentage)

Creates a WColumn with the width specified as a percentage of the total available width.

Parameters:

widthPercentage - the percentage width, 0 for undefined.

Method Detail

setWidth

public void setWidth(int widthPercent)

Sets the relative column width, measured as a percentage of the total available width.

Parameters:

widthPercent - the column width, 0 for undefined.

getWidth

public int getWidth()

Returns:

the column width as a percentage of the total available width, or zero if it has not been specified.

getAlignment

public WColumn.Alignment getAlignment()

Returns:

Returns the alignment.

setAlignment

public void setAlignment(WColumn.Alignment alignment)

Parameters:

alignment - The alignment to set.

toString

public String toString()

Description copied from class: AbstractWComponent

Creates a String representation of this component; usually for debugging purposes.

Overrides:

toString in class AbstractWComponent

Returns:

a String representation of this component, for debugging purposes.

newComponentModel

protected WColumn.ColumnModel newComponentModel()

Creates a new component model appropriate for this component.

Overrides:

newComponentModel in class AbstractWComponent

Returns:

a new ColumnModel.

getComponentModel

protected WColumn.ColumnModel 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 WColumn.ColumnModel 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