|
75
|
1 /*******************************************************************************
|
|
|
2 * Copyright (c) 2007 IBM Corporation and others.
|
|
|
3 * All rights reserved. This program and the accompanying materials
|
|
|
4 * are made available under the terms of the Eclipse Public License v1.0
|
|
|
5 * which accompanies this distribution, and is available at
|
|
|
6 * http://www.eclipse.org/legal/epl-v10.html
|
|
|
7 *
|
|
|
8 * Contributors:
|
|
|
9 * IBM Corporation - initial API and implementation
|
|
|
10 * Port to the D programming language:
|
|
|
11 * Frank Benoit <benoit@tionex.de>
|
|
|
12 ******************************************************************************/
|
|
|
13 module dwtx.ui.forms.IMessagePrefixProvider;
|
|
|
14
|
|
|
15 import dwt.widgets.Control;
|
|
|
16
|
|
|
17 import dwt.dwthelper.utils;
|
|
|
18
|
|
|
19 /**
|
|
|
20 * This interface computes the prefix of a message that is created in the
|
|
|
21 * context of a control. Since messages are rolled up to the header in the
|
|
|
22 * message manager, it is important to create a prefix to indicate the context
|
|
|
23 * of a message in the form. Typically the prefix is computed by looking at the
|
|
|
24 * label that preceeds the control, if present. Alternative providers may
|
|
|
25 * include other text to further specify the location of the message.
|
|
|
26 *
|
|
|
27 * @see IMessageManager
|
|
|
28 * @see IMessage
|
|
|
29 * @since 3.3
|
|
|
30 */
|
|
|
31 public interface IMessagePrefixProvider {
|
|
|
32 /**
|
|
|
33 * Returns the computed prefix for the provided control.
|
|
|
34 *
|
|
|
35 * @param control
|
|
|
36 * the control to provide the prefix for
|
|
|
37 * @return the computed prefix
|
|
|
38 */
|
|
|
39 String getPrefix(Control control);
|
|
|
40 }
|
