summaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/terminal/UserError.java
blob: 804408060e3280709ab71ae437f2c34fd81ed83a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/* *************************************************************************
 
                               IT Mill Toolkit 

               Development of Browser User Interfaces Made Easy

                    Copyright (C) 2000-2006 IT Mill Ltd
                     
   *************************************************************************

   This product is distributed under commercial license that can be found
   from the product package on license/license.txt. Use of this product might 
   require purchasing a commercial license from IT Mill Ltd. For guidelines 
   on usage, see license/licensing-guidelines.html

   *************************************************************************
   
   For more information, contact:
   
   IT Mill Ltd                           phone: +358 2 4802 7180
   Ruukinkatu 2-4                        fax:   +358 2 4802 7181
   20540, Turku                          email:  info@itmill.com
   Finland                               company www: www.itmill.com
   
   Primary source for information and releases: www.itmill.com

   ********************************************************************** */

package com.itmill.toolkit.terminal;

/** User error is a controlled error occurred in application. User errors
 * are occur in normal usage of the application and guide the user.
 *
 * @author IT Mill Ltd.
 * @version @VERSION@
 * @since 3.0
 */
public class UserError implements ErrorMessage {

	/** Content mode, where the error contains only plain text. 
	 */
	public static final int CONTENT_TEXT = 0;

	/** Content mode, where the error contains preformatted text.
	 */
	public static final int CONTENT_PREFORMATTED = 1;

	/** Formatted content mode, where the contents is XML restricted to the
	 * UIDL 1.0 formatting markups.
	 */
	public static final int CONTENT_UIDL = 2;

	/** Content mode */
	private int mode = CONTENT_TEXT;

	/** Message in content mode */
	private String msg;

	/** Error level */
	private int level = ErrorMessage.ERROR;

	/** Create a textual error message of level ERROR.
	 * 
	 * @param textErrorMessage The text of the error message. 
	 */
	public UserError(String textErrorMessage) {
		this.msg = textErrorMessage;
	}

	/** Create error message with level and content mode.
	 */
	public UserError(String message, int contentMode, int errorLevel) {

		// Check the parameters
		if (contentMode < 0 || contentMode > 2)
			throw new java.lang.IllegalArgumentException(
				"Unsupported content mode: " + contentMode);

		this.msg = message;
		this.mode = contentMode;
		this.level = errorLevel;
	}

	/* Documenten in interface */
	public int getErrorLevel() {
		return level;
	}

	/* Documenten in interface */
	public void addListener(RepaintRequestListener listener) {
	}

	/* Documenten in interface */
	public void removeListener(RepaintRequestListener listener) {
	}

	/* Documenten in interface */
	public void requestRepaint() {
	}

	/* Documenten in interface */
	public void paint(PaintTarget target) throws PaintException {

		target.startTag("error");

		// Error level
		if (level >= ErrorMessage.SYSTEMERROR)
			target.addAttribute("level", "system");
		else if (level >= ErrorMessage.CRITICAL)
			target.addAttribute("level", "critical");
		else if (level >= ErrorMessage.ERROR)
			target.addAttribute("level", "error");
		else if (level >= ErrorMessage.WARNING)
			target.addAttribute("level", "warning");
		else
			target.addAttribute("level", "info");

		// Paint the message
		switch (mode) {
			case CONTENT_TEXT :
				target.addText(msg);
				break;
			case CONTENT_UIDL :
				target.addUIDL(msg);
				break;
			case CONTENT_PREFORMATTED :
				target.startTag("pre");
				target.addText(msg);
				target.endTag("pre");
		}

		target.endTag("error");
	}

	/* Documenten in interface */
	public void requestRepaintRequests() {
	}
	
	/* Documented in superclass */
	public String toString() {
		return msg;
	}

}