ALBPM Process API (PAPI)

fuego.papi
Class Presentation.Column

java.lang.Object
  extended byfuego.papi.Presentation.Column
All Implemented Interfaces:
Serializable
Enclosing class:
Presentation

public static class Presentation.Column
extends Object
implements Serializable

Column contains every attribute for a column, the main idea is to get and keep all the neccesary info, like size and id, etc.

See Also:
Serialized Form

Constructor Summary
Presentation.Column(String variableId, int size)
          Creates a new column.
Presentation.Column(String variableId, int size, ColumnFormat columnFormat)
           
Presentation.Column(VarDefinition varDefinition)
          Creates a new column.
 
Method Summary
 ColumnFormat getColumnFormat()
          Gets the format of this column
 String getFormattedValue(Object value, Locale locale)
          Gets the value received formatted following the variable definition for this column.
 String getFormattedValue(Object value, Locale locale, PresentationColumnFormat columFormat)
          Gets the value received formatted by the given column format.
 String getId()
          Returns the key of this column.
 String getLabel(Locale locale)
          Returns the localized label for this column.
 int getSize()
          Returns the size of this column.
 VarDefinition getVarDefinition()
          Gets the VarDefinition of this column.
 void setColumnFormat(ColumnFormat columnFormat)
          Sets the format of this column
 void setSize(int size)
          Sets the size of this column.
 void setVarDefinition(VarDefinition varDefinition)
          Sets the VarDefinition for this column.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Presentation.Column

public Presentation.Column(VarDefinition varDefinition)
Creates a new column.

Parameters:
varDefinition - VarDefinition that will be paced inside this column.

Presentation.Column

public Presentation.Column(String variableId,
                           int size)
Creates a new column.

Parameters:
variableId - variable Id that will be paced inside this column.
size - size of the column.

Presentation.Column

public Presentation.Column(String variableId,
                           int size,
                           ColumnFormat columnFormat)
Method Detail

getFormattedValue

public String getFormattedValue(Object value,
                                Locale locale)
Gets the value received formatted following the variable definition for this column.

Parameters:
value - The value to be formatted
locale - The locale to be used to format the value
Returns:
A String with the formatted value

getFormattedValue

public String getFormattedValue(Object value,
                                Locale locale,
                                PresentationColumnFormat columFormat)
Gets the value received formatted by the given column format.

Parameters:
value - The value to be formatted
locale - The locale to be used to format the value
columFormat - The custom formatter
Returns:
A String with the formatted value

getId

public String getId()
Returns the key of this column.

Returns:
the key of this column.

getLabel

public String getLabel(Locale locale)
Returns the localized label for this column.

Returns:
the localized label for this column.

setSize

public void setSize(int size)
Sets the size of this column.

Parameters:
size - The new size of this column.

getSize

public int getSize()
Returns the size of this column.

Returns:
size of this column

setVarDefinition

public void setVarDefinition(VarDefinition varDefinition)
Sets the VarDefinition for this column.

The VarDefinition will set only if the Id of the column is the same that the VarDefinition.

Parameters:
varDefinition - VarDefinitio to set.

getVarDefinition

public VarDefinition getVarDefinition()
Gets the VarDefinition of this column.

Note: the VarDefinition could be null if it was not set before.

Returns:
VarDefinitio of this column.

getColumnFormat

public ColumnFormat getColumnFormat()
Gets the format of this column

Returns:
the format

setColumnFormat

public void setColumnFormat(ColumnFormat columnFormat)
Sets the format of this column

Parameters:
columnFormat -

ALBPM Process API (PAPI)

© Copyright 1996/2005 Fuego Inc. All Rights Reserved