LibreCCM
/
libreccm-legacy
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CCM-Core 

Hinzugefügt:
 * Label: Keys werden als Attribut mit ausgegeben, wenn e sich nicht um ein automatisch generiertes GlobalizedMessage Objekt handelt

Geändert:
 * TabbedPane: Ausgabe des Keys gekürzt

git-svn-id: https://svn.libreccm.org/ccm/trunk@2177 8810af33-2d31-482b-a856-94f89814c4df
master
quasi 2013-06-06 09:59:19 +00:00
parent 61934c3174
commit 98f4af8da3
2 changed files with 95 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

172
ccm-core/src/com/arsdigita/bebop/Label.java
View File

@ -25,9 +25,9 @@ import com.arsdigita.globalization.GlobalizedMessage;
import com.arsdigita.xml.Element; import com.arsdigita.xml.Element;
/** /**
* A text label. The label can be used to generate either some static, * A text label. The label can be used to generate either some static, fixed
* fixed text or a new text string for every request. To set a new * text or a new text string for every request. To set a new text string for
* text string for each request, use the {@link * each request, use the {@link
* #setLabel(String,PageState)} method. * #setLabel(String,PageState)} method.
* *
* @author David Lutterkort * @author David Lutterkort
@ -36,30 +36,27 @@ import com.arsdigita.xml.Element;
public class Label extends BlockStylable implements Cloneable { public class Label extends BlockStylable implements Cloneable {
private static final String NO_LABEL = ""; private static final String NO_LABEL = "";
public static final String BOLD = "b"; public static final String BOLD = "b";
public static final String ITALIC = "i"; public static final String ITALIC = "i";
// the default label // the default label
private GlobalizedMessage m_label; private GlobalizedMessage m_label;
// a requestlocal set of labels (to avoid printlisteners) // a requestlocal set of labels (to avoid printlisteners)
private RequestLocal m_requestLabel = new RequestLocal(); private RequestLocal m_requestLabel = new RequestLocal();
private String m_fontWeight; private String m_fontWeight;
private boolean m_escaping; private boolean m_escaping;
private PrintListener m_printListener; private PrintListener m_printListener;
/** /**
* Creates a new <code>Label</code> with empty text. * Creates a new
* <code>Label</code> with empty text.
*/ */
public Label() { public Label() {
this(NO_LABEL); this(NO_LABEL);
} }
/** /**
* Creates a new <code>Label</code> with the specified text. * Creates a new
* <code>Label</code> with the specified text.
* *
* @param label the text to display * @param label the text to display
*/ */
@ -68,20 +65,20 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* Creates a new <code>Label</code> with the specified text and * Creates a new
* output escaping turned on if <code>escaping</code> is * <code>Label</code> with the specified text and output escaping turned on
* <code>true</code>. * if
* The setting foroutput escaping affects how markup in * <code>escaping</code> is
* the <code>label</code> is handled. For example: * <code>true</code>. The setting foroutput escaping affects how markup in
* <UL><LI>If output escaping is in effect, &lt;b>text&lt;/b> will * the
* appear literally.</LI> * <code>label</code> is handled. For example: <UL><LI>If output escaping is
* <LI>If output escaping is disabled, * in effect, &lt;b>text&lt;/b> will appear literally.</LI> <LI>If output
* &lt;b>text&lt;/b> appears as the word "text" in bold.</LI></UL> * escaping is disabled, &lt;b>text&lt;/b> appears as the word "text" in
* bold.</LI></UL>
* *
* @param label the text to display * @param label the text to display
* @param <code>true</code> if output escaping will be in effect; * @param <code>true</code> if output escaping will be in effect;
* <code>false</code> if output escaping * <code>false</code> if output escaping will be disabled
* will be disabled
*/ */
public Label(String label, boolean escaping) { public Label(String label, boolean escaping) {
setLabel(label); setLabel(label);
@ -89,9 +86,7 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* <p> * <p> Creates a new label with the specified text. </p>
* Creates a new label with the specified text.
* </p>
* *
* @param label the text to display * @param label the text to display
*/ */
@ -100,11 +95,10 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* <p> * <p> Creates a new label with the specified text and output escaping
* Creates a new label with the specified text and * turned on if
* output escaping turned on if <code>escaping</code> is * <code>escaping</code> is
* <code>true</code>. * <code>true</code>. </p>
* </p>
* *
* @param label the text to display * @param label the text to display
* @param escaping Whether or not to perform output escaping * @param escaping Whether or not to perform output escaping
@ -115,8 +109,8 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* Creates a new <code>Label</code> that uses the print listener * Creates a new
* to generate output. * <code>Label</code> that uses the print listener to generate output.
* *
* @param l the print listener used to produce output * @param l the print listener used to produce output
*/ */
@ -138,15 +132,14 @@ public class Label extends BlockStylable implements Cloneable {
/** /**
* . * .
* Although it is not recommended, this method may be overridden * Although it is not recommended, this method may be overridden to
* to dynamically generate the text of the label. Overriding * dynamically generate the text of the label. Overriding code may need the
* code may need the page state. <p>If possible, * page state. <p>If possible, derived classes should override
* derived classes should override {@link #getLabel()} instead, * {@link #getLabel()} instead, which is called from this method. As long as
* which is called from this method. As long as we don't have a * we don't have a static method to obtain ApplicationContext, this is a way
* static method to obtain ApplicationContext, this is a way to * to get the RequestContext (that is, to determine the locale). When
* get the RequestContext (that is, to determine the locale). When * ApplicationContext gets available, that will become the suggested way for
* ApplicationContext gets available, that will become the * overriding code to get context.
* suggested way for overriding code to get context.
* *
* @param state the current page state * @param state the current page state
* @return the string produced for this label * @return the string produced for this label
@ -158,8 +151,8 @@ public class Label extends BlockStylable implements Cloneable {
/** /**
* . * .
* *
* This method may be overridden to dynamically generate the default text * This method may be overridden to dynamically generate the default text of
* of the label. * the label.
* *
* @return the string produced for this label. * @return the string produced for this label.
* *
@ -170,10 +163,8 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* <p> * <p> This should really be getLabel(), but since it was marked STABLE I
* This should really be getLabel(), but since it was marked STABLE I can't * can't change its return type. </p>
* change its return type.
* </p>
* *
* @return the default label to display. * @return the default label to display.
*/ */
@ -182,14 +173,12 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* <p> * <p> This should really be getLabel(), but since it was marked STABLE I
* This should really be getLabel(), but since it was marked STABLE I can't * can't change its return type. </p>
* change its return type.
* </p>
* *
* @param the current PageState * @param the current PageState
* @return the label to display for this request, or if state is null, * @return the label to display for this request, or if state is null, the
* the default label * default label
*/ */
public GlobalizedMessage getGlobalizedMessage(PageState state) { public GlobalizedMessage getGlobalizedMessage(PageState state) {
if (state != null) { if (state != null) {
@ -204,23 +193,24 @@ public class Label extends BlockStylable implements Cloneable {
/** /**
* Sets new default text for this Label. * Sets new default text for this Label.
* @param label The new label text; will be used as a key into the *
* current ResourceBundle if possible, or displayed literally. * @param label The new label text; will be used as a key into the current
* ResourceBundle if possible, or displayed literally.
*/ */
public void setLabel(String label) { public void setLabel(String label) {
setLabel(label, null); setLabel(label, null);
} }
/** /**
* Sets new request-specific text for this Label to use on this * Sets new request-specific text for this Label to use on this request. If
* request. If state is null, then sets the default text instead. * state is null, then sets the default text instead.
* *
* @param label The new label text; will be used as a key into the * @param label The new label text; will be used as a key into the current
* current ResourceBundle if possible, or displayed literally. * ResourceBundle if possible, or displayed literally.
* @param state the page state * @param state the page state
* @pre state == null implies !isLocked() * @pre state == null implies !isLocked()
* @deprecated refactor to use @see setLabel(GlobalizedMessage, PageState) * @deprecated refactor to use
* instead! * @see setLabel(GlobalizedMessage, PageState) instead!
*/ */
public void setLabel(String label, PageState state) { public void setLabel(String label, PageState state) {
if (label == null || label.length() == 0) { if (label == null || label.length() == 0) {
@ -231,10 +221,11 @@ public class Label extends BlockStylable implements Cloneable {
/** /**
* Sets the text for this label using a GlobalizedMessage. * Sets the text for this label using a GlobalizedMessage.
* @param label The GlobalizedMessage containing the label *
* text or the lookup key to use in the ResourceBundle * @param label The GlobalizedMessage containing the label text or the
* @param state the current page state; if null, sets the * lookup key to use in the ResourceBundle
* default text for all requests. * @param state the current page state; if null, sets the default text for
* all requests.
* @pre state == null implies !isLocked() * @pre state == null implies !isLocked()
*/ */
public void setLabel(GlobalizedMessage label, PageState state) { public void setLabel(GlobalizedMessage label, PageState state) {
@ -248,8 +239,9 @@ public class Label extends BlockStylable implements Cloneable {
/** /**
* Sets the default text for this Label. * Sets the default text for this Label.
* @param label The GlobalizedMessage containing the label *
* text or the lookup key to use in the ResourceBundle * @param label The GlobalizedMessage containing the label text or the
* lookup key to use in the ResourceBundle
*/ */
public void setLabel(GlobalizedMessage label) { public void setLabel(GlobalizedMessage label) {
setLabel(label, null); setLabel(label, null);
@ -260,9 +252,9 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* Controls whether output is escaped during transformation, by default true. * Controls whether output is escaped during transformation, by default
* If true, it will be printed literally, and the user will see &lt;b&gt;. * true. If true, it will be printed literally, and the user will see
* When false, the browser will interpret as a bold tag. * &lt;b&gt;. When false, the browser will interpret as a bold tag.
*/ */
public final void setOutputEscaping(boolean escaping) { public final void setOutputEscaping(boolean escaping) {
m_escaping = escaping; m_escaping = escaping;
@ -278,32 +270,33 @@ public class Label extends BlockStylable implements Cloneable {
} }
/** /**
* Adds a print listener. Only one print listener can be set for a * Adds a print listener. Only one print listener can be set for a label,
* label, since the <code>PrintListener</code> is expected to modify the * since the
* target of the <code>PrintEvent</code>. * <code>PrintListener</code> is expected to modify the target of the
* <code>PrintEvent</code>.
*
* @param listener the print listener * @param listener the print listener
* @throws IlegalArgumentException if <code>listener</code> is null. * @throws IlegalArgumentException if <code>listener</code> is null.
* @throws IllegalStateException if a print listener has previously been * @throws IllegalStateException if a print listener has previously been
* added. * added.
* @pre listener != null */ * @pre listener != null
*/
public void addPrintListener(PrintListener listener) public void addPrintListener(PrintListener listener)
throws IllegalStateException, IllegalArgumentException throws IllegalStateException, IllegalArgumentException {
{
if (listener == null) { if (listener == null) {
throw new IllegalArgumentException throw new IllegalArgumentException("Argument listener can not be null");
("Argument listener can not be null");
} }
if (m_printListener != null) { if (m_printListener != null) {
throw new IllegalStateException throw new IllegalStateException("Too many listeners. Can only have one");
("Too many listeners. Can only have one");
} }
m_printListener = listener; m_printListener = listener;
} }
/** /**
* Removes a previously added print listener. If <code>listener</code> is * Removes a previously added print listener. If
* not the listener that was added with {@link #addPrintListener * <code>listener</code> is not the listener that was added with {@link #addPrintListener
* addPrintListener}, an IllegalArgumentException will be thrown. * addPrintListener}, an IllegalArgumentException will be thrown.
*
* @param listener the listener that was added with * @param listener the listener that was added with
* <code>addPrintListener</code> * <code>addPrintListener</code>
* @throws IllegalArgumentException if <code>listener</code> is not the * @throws IllegalArgumentException if <code>listener</code> is not the
@ -311,14 +304,12 @@ public class Label extends BlockStylable implements Cloneable {
* @pre listener != null * @pre listener != null
*/ */
public void removePrintListener(PrintListener listener) public void removePrintListener(PrintListener listener)
throws IllegalArgumentException throws IllegalArgumentException {
{
if (listener == null) { if (listener == null) {
throw new IllegalArgumentException("listener can not be null"); throw new IllegalArgumentException("listener can not be null");
} }
if (listener != m_printListener) { if (listener != m_printListener) {
throw new IllegalArgumentException throw new IllegalArgumentException("listener is not registered with this widget");
("listener is not registered with this widget");
} }
m_printListener = null; m_printListener = null;
} }
@ -345,6 +336,13 @@ public class Label extends BlockStylable implements Cloneable {
label.addAttribute("escape", "no"); label.addAttribute("escape", "no");
} }
String key = getGlobalizedMessage().getKey().substring(getGlobalizedMessage().getKey().lastIndexOf(".") + 1);
// This if clause is needed to prevent printing of keys if the GlobalizedMessage was created from a String by this class
if(!key.equals(target.getLabel(state))) {
label.addAttribute("key", key);
}
/* /*
* This may break with normal JDOM. We may need to have a node * This may break with normal JDOM. We may need to have a node
* for the case where there is no weight. The problem comes in that * for the case where there is no weight. The problem comes in that
@ -363,8 +361,8 @@ public class Label extends BlockStylable implements Cloneable {
m_printListener.prepare(new PrintEvent(this, state, l)); m_printListener.prepare(new PrintEvent(this, state, l));
} catch (CloneNotSupportedException e) { } catch (CloneNotSupportedException e) {
throw new RuntimeException( throw new RuntimeException(
"Couldn't clone Label for PrintListener. " + "Couldn't clone Label for PrintListener. "
"This probably indicates a serious programming error: " + "This probably indicates a serious programming error: "
+ e.getMessage()); + e.getMessage());
} }
} }

3
ccm-core/src/com/arsdigita/bebop/TabbedPane.java
View File

@ -411,7 +411,8 @@ public class TabbedPane extends SimpleContainer {
//TODO cat.error("cannot get stateAsURL from "+data); //TODO cat.error("cannot get stateAsURL from "+data);
} }
} }
tab.addAttribute("key", ((Label) pane.getLabel()).getGlobalizedMessage().getKey()); String key = ((Label) pane.getLabel()).getGlobalizedMessage().getKey();
tab.addAttribute("key", key.substring(key.lastIndexOf(".") + 1));
pane.getLabel().generateXML(data, tab); pane.getLabel().generateXML(data, tab);
} }
data.clearControlEvent(); data.clearControlEvent();