casa.socialcommitments

Class SocialCommitmentHTMLFormatter

java.lang.Object

casa.socialcommitments.SocialCommitmentHTMLFormatter

public class SocialCommitmentHTMLFormatter
extends Object

SocialCommitmentHTMLFormatter is a class which can be used to format SocialCommitment objects using HTML tages. This formatter is intended to be used when social commitments are in JLists. The text describing the social commitment results from a call to SocialCommitment.toString(). The text is formatted as plain black text with the following modifications:

• If the commitment has been fulfilled or canceled, the entire commitment is formatted with strike-through (using the <strike> tag).
• If the commitment has been violated, the font colour is changed to red.
• If the commitment has ended (fulfilled, canceled or violated), it is faded in proportion to the amount of time that has passed since the commitment ended. The speed of the fading is controlled by a parameter.

Version:

0.9

Author:

Jason Heard

Constructor Summary

Constructors

Constructor and Description
SocialCommitmentHTMLFormatter()

Method Summary

Modifier and Type	Method and Description
private static String	fadeColor(SocialCommitment socialCommitment, long fadeTime)
static String	formatCommitment(SocialCommitment socialCommitment, long fadeTime) Formats a SocialCommitment object using HTML tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocialCommitmentHTMLFormatter

public SocialCommitmentHTMLFormatter()

Method Detail

formatCommitment

public static String formatCommitment(SocialCommitment socialCommitment,
                                      long fadeTime)

Formats a SocialCommitment object using HTML tags. A description of the formatting can be found in this classes description.

Parameters:

socialCommitment - The social commitment to format.

fadeTime - The time in milliseconds that it takes a commitment to fade out when it ends (is fulfilled, canceled, or violated).

Returns:

A string containing HTML code which will print the commitment.

fadeColor

private static String fadeColor(SocialCommitment socialCommitment,
                                long fadeTime)

Parameters:

fadeTime -

socialCommitment -