org.josef.web.jsf.converter

Class PaddingConverter

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.converter.PaddingConverter

All Implemented Interfaces:

Serializable, javax.faces.component.StateHolder, javax.faces.convert.Converter

public class PaddingConverter
extends AbstractStateHolder
implements javax.faces.convert.Converter, Serializable

Padding converter.
Performs padding with a pad character, either to the left or the right. Usage:
<jf:paddingConverter [character="pad-character"] [position="LEFT|RIGHT]" [minLength="minimum-length-to-pad-from"] length="length-to-pad-to" />
character: The character to use for padding. Defaults to a zero.
position: Either LEFT or RIGHT and must be in upper case! Defaults to LEFT.
minLength: The minimum length from which padding will take place.
When the value is "123" and the minLength is 4, no padding will take place.
length: The length to padd to.
When the entered value is already longer than the length, no padding will take place.

Version:

1.0 $Revision: 5792 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PaddingConverter()

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, String value) Converts the supplied String value to a new padded String.
String	getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object value) Converts the supplied value to a String, by calling toString() on it.
char	getCharacter() Gets the pad character.
int	getLength() Gets the length to pad to.
int	getMinLength() Gets the minimum length to pad from.
PadPosition	getPosition() Gets the pad position.
void	restoreState(javax.faces.context.FacesContext facesContext, Object state) Restores the state saved by saveState(FacesContext).
Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this converter.
void	setCharacter(char character) Sets the pad character.
void	setLength(int length) Sets the length to pad to.
void	setMinLength(int minLength) Sets the minimum length to pad from.
void	setPosition(PadPosition position) Sets the pad position.

Methods inherited from class org.josef.web.jsf.AbstractStateHolder

isTransient, setTransient

Methods inherited from class java.lang.Object

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

Constructor Detail

PaddingConverter

public PaddingConverter()

Method Detail

getCharacter

public char getCharacter()

Gets the pad character.

Returns:

The pad character.

setCharacter

public void setCharacter(char character)

Sets the pad character.

Parameters:

character - The pad character.

getPosition

public PadPosition getPosition()

Gets the pad position.

Returns:

The pad position.

setPosition

public void setPosition(PadPosition position)

Sets the pad position.

Parameters:

position - The pad position.

getMinLength

public int getMinLength()

Gets the minimum length to pad from.

Returns:

The minimum length to pad from.

setMinLength

public void setMinLength(int minLength)

Sets the minimum length to pad from.

Parameters:

minLength - The minimum length to pad from.

getLength

public int getLength()

Gets the length to pad to.

Returns:

The length to pad to.

setLength

public void setLength(int length)

Sets the length to pad to.

Parameters:

length - The length to pad to.

getAsObject

public Object getAsObject(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent component,
                          String value)

Converts the supplied String value to a new padded String.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the String value.

value - The value to convert.

Returns:

The converted value.

getAsString

public String getAsString(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent component,
                          Object value)

Converts the supplied value to a String, by calling toString() on it.

Specified by:

getAsString in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the String value.

value - The value to convert to a String.

Returns:

The converted String value of the supplied value.
Null is returned when either the supplied value is null or when the supplied value is not of type String.

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Saves the state of this converter.

Specified by:

saveState in interface javax.faces.component.StateHolder

Parameters:

facesContext - The FacesContext.

Returns:

The saved state of this converter.

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Restores the state saved by saveState(FacesContext).

Specified by:

restoreState in interface javax.faces.component.StateHolder

Parameters:

facesContext - The FacesContext.

state - The state saved by saveState(FacesContext).