Package org.silverpeas.core.web.util.viewgenerator.html.arraypanes

Class ArrayColumn

java.lang.Object

org.silverpeas.core.web.util.viewgenerator.html.arraypanes.ArrayColumn

All Implemented Interfaces:

SimpleGraphicElement

public class ArrayColumn
extends Object
implements SimpleGraphicElement

Version:

Author:

squere

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alignement
static int	COLUMN_BEHAVIOUR_DEFAULT
static int	COLUMN_BEHAVIOUR_NO_TRIGGER	This behaviour is set when a column header is not sortable.
protected int	columnNumber
protected int	m_Behaviour
protected String	m_RoutingAddress	In some cases, it may be preferable to specify the routing address (via setRoutingAddress(String address)) If not the print() method defaults to an address derived from the request URL.
protected ArrayPane	pane
protected String	title
protected String	width

Constructor Summary

Constructors

Constructor	Description
ArrayColumn(String title, int columnNumber, ArrayPane pane)	Constructor declaration

Method Summary

Modifier and Type	Method	Description
String	getAlignement()	Method declaration
int	getColumnNumber()	Method declaration
<T,V> BiFunction<T,Integer,Comparable<V>>	getCompareOn()
boolean	getSortable()	Method declaration
String	getTitle()	Method declaration
static String	getVersion()	standard method that returns the CVS-managed version string
String	getWidth()
protected boolean	isArrayPaneURL(String address)	Method declaration
String	print()	Method declaration
String	print(boolean xhtml)
void	setAlignement(String alignement)	Method declaration
void	setBehaviour(int behaviour)	Deprecated.
<T,V> void	setCompareOn(BiFunction<T,Integer,Comparable<V>> compareOn)
void	setRoutingAddress(String address)	This method sets the routing address.
void	setSortable(boolean sortable)	Set the column to be sortable or not.
void	setTitle(String title)	Method declaration
void	setWidth(String width)

Methods inherited from class java.lang.Object

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

Field Detail

COLUMN_BEHAVIOUR_NO_TRIGGER

public static final int COLUMN_BEHAVIOUR_NO_TRIGGER

This behaviour is set when a column header is not sortable. No hyperlink will be anchored around the title of the column.

See Also:

setBehaviour(int behaviour), Constant Field Values

COLUMN_BEHAVIOUR_DEFAULT

public static final int COLUMN_BEHAVIOUR_DEFAULT

See Also:

Constant Field Values

title

protected String title

alignement

protected String alignement

columnNumber

protected int columnNumber

pane

protected ArrayPane pane

m_Behaviour

protected int m_Behaviour

width

protected String width

m_RoutingAddress

protected String m_RoutingAddress

In some cases, it may be preferable to specify the routing address (via setRoutingAddress(String address)) If not the print() method defaults to an address derived from the request URL. Note that te routing address may start with the protocol string arraypane:, in which case a javascript:doArrayPane() URL is issued instead of a standard URL.

Constructor Detail

ArrayColumn

public ArrayColumn(String title,
                   int columnNumber,
                   ArrayPane pane)

Constructor declaration

Parameters:

title -

columnNumber -

pane -

Method Detail

getVersion

public static String getVersion()

standard method that returns the CVS-managed version string

Returns:

setRoutingAddress

public void setRoutingAddress(String address)

This method sets the routing address. This is actually the URL of the page to which requests will be routed when the user clicks on a column header link.

Parameters:

address -

setSortable

public void setSortable(boolean sortable)

Set the column to be sortable or not. If the array is already unsortable, this method will have no effect.

Parameters:

sortable - A true value will enable this column to be sorted

getSortable

public boolean getSortable()

Method declaration

Returns:

getCompareOn

public <T,V> BiFunction<T,Integer,Comparable<V>> getCompareOn()

setCompareOn

public <T,V> void setCompareOn(BiFunction<T,Integer,Comparable<V>> compareOn)

setBehaviour

@Deprecated
public void setBehaviour(int behaviour)

Deprecated.

This method changes the column behaviour, if the argument behaviour is valid

Parameters:

behaviour -

setTitle

public void setTitle(String title)

Method declaration

Parameters:

title -

setAlignement

public void setAlignement(String alignement)

Method declaration

Parameters:

alignement -

getTitle

public String getTitle()

Method declaration

Returns:

getAlignement

public String getAlignement()

Method declaration

Returns:

getColumnNumber

public int getColumnNumber()

Method declaration

Returns:

setWidth

public void setWidth(String width)

getWidth

public String getWidth()

isArrayPaneURL

protected boolean isArrayPaneURL(String address)

Method declaration

Parameters:

address -

Returns:

print

public String print()

Method declaration

Specified by:

print in interface SimpleGraphicElement

Returns:

print

public String print(boolean xhtml)