Component / Message Association #6

glassfishrobot · 2004-08-19T10:42:43Z

A previous version of the RI incorporated the cryptic clientId in messages (for
example, validation messages) as an attempt to show which component the message
was associated with. We need to come up with a better way of doing this. More
information from the archives:

The proper way involves adding a new property to our components that
describes the "name"/"prompt"/"label" etc. that can be incorporated
into validation messages but can still be translated, user-readable
text. Doing so is obviously an API change, but there's no way to
add this feature correctly without extending the JSF API.

– Adam

Environment

Operating System: All
Platform: All

Affected Versions

[1.2]

glassfishrobot · 2004-08-19T10:42:43Z

Reported by rogerk

glassfishrobot · 2004-08-19T10:42:43Z

Was assigned to rogerk

glassfishrobot · 2004-08-30T11:14:24Z

@edburns said:
Move to p3 feature.

glassfishrobot · 2004-10-07T12:16:21Z

@edburns said:
Give this to Roger.

glassfishrobot · 2005-01-10T13:59:04Z

rogerk said:
Submitted initial proposal.

glassfishrobot · 2005-02-08T09:15:44Z

rogerk said:
This change bundle implements this issue with the following key points:

a "label" attribute has been added to all input components
the value of the "label" attribute is substituted at the start
of the implementation's default message (defined in Messages.properties).
For example ( {1} is the placeholder for "label" value here:
javax.faces.converter.BigDecimalConverter.DECIMAL={1}

''

{0}

'' must be a
signed decimal number.
the "label" can be a binding expression that may refer to a resource bundle
key that is the I18n'd label. For an example of this - check out
converter04.jsp under the RI's systest/web included in the change bundle.
(thanks to Adam Winer for his suggestion and code sample)

SECTION: Modified Files

M jsf-api/build.xml

added entry to create MessageFactory.java for converters
M jsf-api/doc/input-attrs.xml
generated from input-props.xml
M jsf-api/doc/input-props.xml
added "label" attribute
M jsf-api/doc/standard-html-renderkit.xml
generated - includes "label" attribute
M jsf-api/src/javax/faces/convert/BigDecimalConverter.java
M jsf-api/src/javax/faces/convert/BigIntegerConverter.java
M jsf-api/src/javax/faces/convert/BooleanConverter.java
M jsf-api/src/javax/faces/convert/ByteConverter.java
M jsf-api/src/javax/faces/convert/CharacterConverter.java
M jsf-api/src/javax/faces/convert/DateTimeConverter.java
M jsf-api/src/javax/faces/convert/DoubleConverter.java
M jsf-api/src/javax/faces/convert/FloatConverter.java
M jsf-api/src/javax/faces/convert/IntegerConverter.java
M jsf-api/src/javax/faces/convert/LongConverter.java
M jsf-api/src/javax/faces/convert/NumberConverter.java
M jsf-api/src/javax/faces/convert/ShortConverter.java
added message constants; use them in ConverterException(s)
M jsf-api/src/javax/faces/validator/DoubleRangeValidator.java
M jsf-api/src/javax/faces/validator/LengthValidator.java
M jsf-api/src/javax/faces/validator/LongRangeValidator.java
M jsf-api/src/javax/faces/validator/Validator.java
updated javadocs;
include component label in the parameter array for messages
M jsf-ri/src/javax/faces/Messages.properties
M jsf-ri/src/javax/faces/Messages_de.properties
M jsf-ri/src/javax/faces/Messages_es.properties
M jsf-ri/src/javax/faces/Messages_fr.properties
updated to include converter messages;
also included new "label" value placeholder at the beginning
of messages.
M jsf-ri/systest/build-tests.xml
included new test for converter messages
M jsf-ri/systest/src/com/sun/faces/CustomMessages.properties
contains a component label to illustrate the inclusion of the label
from a resource bundle.
M jsf-ri/systest/src/com/sun/faces/jsptest/ConverterTestCase.java
M jsf-ri/systest/src/com/sun/faces/jsptest/ValidatorTestCase.java
included tests for messages
M jsf-ri/systest/web/converter03.jsp
M jsf-tools/template-src/MessageFactory.java
include specialized FacesMessage class (inner) that performs late
binding evaluation for message substitution parameters.

A jsf-ri/systest/web/converter04.jsp
A jsf-ri/systest/web/validator03.jsp

new test pages

glassfishrobot · 2005-02-08T09:25:21Z

rogerk said:
Created an attachment (id=11)
Change bundle and new files for issue 6.

glassfishrobot · 2005-02-08T09:25:21Z

File: issue-6.zip.gz
Attached By: rogerk

glassfishrobot · 2005-02-14T07:42:24Z

rogerk said:
Changes to reflect last set of requests from EG. Key points:

a "label" attribute has been added to all input components
the "label" attribute value is added to the end of the Object
parameter array (passed as an arg to MessageFactory.getMessage)
if the label attribute has not been specified as a literal or
binding expression (i.e. it is null), then the component's client id
will be used as the default label value.
the value of the "label" attribute is substituted at the start
of the implementation's default message (defined in Messages.properties).
For example ( {1} is the placeholder for "label" value here:
javax.faces.converter.BigDecimalConverter.DECIMAL={1}

''

{0}

'' must be a
signed decimal number.
the "label" can be a binding expression that may refer to a resource bundle
key that is the I18n'd label. For an example of this - check out
converter04.jsp under the RI's systest/web included in the change bundle.
(thanks to Adam Winer for his suggestion and code sample)

SECTION: Modified Files

M jsf-api/build.xml
M jsf-api/doc/input-attrs.xml
M jsf-api/doc/input-props.xml
M jsf-api/doc/standard-html-renderkit.xml
M jsf-api/src/javax/faces/convert/BigDecimalConverter.java
M jsf-api/src/javax/faces/convert/BigIntegerConverter.java
M jsf-api/src/javax/faces/convert/BooleanConverter.java
M jsf-api/src/javax/faces/convert/ByteConverter.java
M jsf-api/src/javax/faces/convert/CharacterConverter.java
M jsf-api/src/javax/faces/convert/DateTimeConverter.java
M jsf-api/src/javax/faces/convert/DoubleConverter.java
M jsf-api/src/javax/faces/convert/FloatConverter.java
M jsf-api/src/javax/faces/convert/IntegerConverter.java
M jsf-api/src/javax/faces/convert/LongConverter.java
M jsf-api/src/javax/faces/convert/NumberConverter.java
M jsf-api/src/javax/faces/convert/ShortConverter.java
M jsf-api/src/javax/faces/validator/DoubleRangeValidator.java
M jsf-api/src/javax/faces/validator/LengthValidator.java
M jsf-api/src/javax/faces/validator/LongRangeValidator.java
M jsf-api/src/javax/faces/validator/Validator.java
M jsf-ri/src/javax/faces/Messages.properties
M jsf-ri/src/javax/faces/Messages_de.properties
M jsf-ri/src/javax/faces/Messages_es.properties
M jsf-ri/src/javax/faces/Messages_fr.properties
M jsf-ri/systest/build-tests.xml
M jsf-ri/systest/src/com/sun/faces/CustomMessages.properties
M jsf-ri/systest/src/com/sun/faces/jsptest/ConverterTestCase.java
M jsf-ri/systest/src/com/sun/faces/jsptest/ValidatorTestCase.java
M jsf-ri/systest/web/converter03.jsp
M jsf-tools/template-src/MessageFactory.java

A jsf-ri/systest/web/converter04.jsp
A jsf-ri/systest/web/validator03.jsp

For final EG discussion on this issue:
http://archives.java.sun.com/cgi-bin/wa?A2=ind0502&L=jsr-252-eg&F=&S=&X=1E63493BEBE56FA37C&Y=roger.kitain@sun.com&P=3866

glassfishrobot · 2005-02-14T07:47:53Z

rogerk said:
Created an attachment (id=12)
Change Bundle For Issue 6

glassfishrobot · 2005-02-14T07:47:53Z

File: issue-6.zip.gz
Attached By: rogerk

glassfishrobot · 2005-02-22T08:52:29Z

rogerk said:
Created another attachment that does not include input-attrs.xml.

glassfishrobot · 2005-02-22T08:53:36Z

rogerk said:
Created an attachment (id=14)
Latest Change bundle For Issue 6.

glassfishrobot · 2005-02-22T08:53:36Z

File: issue-6.zip.gz
Attached By: rogerk

glassfishrobot · 2005-02-22T14:44:59Z

@edburns said:
RK> Changes to reflect last set of requests from EG. Key points:
RK>
RK> - a "label" attribute has been added to all input components
RK> - the "label" attribute value is added to the end of the Object
RK> parameter array (passed as an arg to MessageFactory.getMessage)
RK> - if the label attribute has not been specified as a literal or
RK> binding expression (i.e. it is null), then the component's client id
RK> will be used as the default label value.
RK> - the value of the "label" attribute is substituted at the start
RK> of the implementation's default message (defined in Messages.properties).
RK> For example (

{1} is the placeholder for "label" value here:
RK> javax.faces.converter.BigDecimalConverter.DECIMAL={1}

''

{0}

'' must be a
RK> signed decimal number.
RK> - the "label" can be a binding expression that may refer to a resource bundle
RK> key that is the I18n'd label. For an example of this - check out
RK> converter04.jsp under the RI's systest/web included in the change bundle.
RK> (thanks to Adam Winer for his suggestion and code sample)
RK>
RK> SECTION: Modified Files
RK> ----------------------------
RK> M jsf-api/build.xml

Ok.

RK> M jsf-api/doc/input-attrs.xml

Don't check this in. Jayashri has CVS removed it. *-attrs.xml files
must not be checked in. They are generated by the build process.

RK> M jsf-api/doc/input-props.xml

I don't like the description.

A presentable name for this component that can be used
in messages.

How about:

A localized user presentable name for this component that can be used in messages relating to that component.

RK> M jsf-api/doc/standard-html-renderkit.xml

Did you edit this file directly? You have to edit the shr-base.xml one,
and check in the edited and generated ones.

RK> M jsf-api/src/javax/faces/convert/BigDecimalConverter.java

The javadoc for the DECIMAL appears to have a parameter list ordering
mismatch. The label is second in the javadoc, but last in the parameter
list. Looks like the javadoc is wrong.

I know you copied and pasted the method

private Object getLabel(FacesContext context, UIComponent component) {

into every class because there was no better place to put it,
but...there is, IMHO. Put it as a package private static method on
MessageFactory.java. MessageFactory is necessarily in every package
that would use getLabel(). Also, as a nit, there's no need for a local
variable to store the componentLabel, you can just invoke it in the
Object [] argument list. Please remove the copied and pasted getLabel()
from all converter and validator classes and use the one on
MessageFactory instead.

RK> M jsf-api/src/javax/faces/convert/BigIntegerConverter.java

the same apparent ordering mismatch as in BigDecimal appears to be
here as well.

RK> M jsf-api/src/javax/faces/convert/BooleanConverter.java

Same nit about the local variable for componentLabel.

RK> M jsf-api/src/javax/faces/convert/ByteConverter.java

javadoc for both messages has two substitution params, code has two.

RK> M jsf-api/src/javax/faces/convert/DateTimeConverter.java
RK> M jsf-api/src/javax/faces/convert/DoubleConverter.java
RK> M jsf-api/src/javax/faces/convert/FloatConverter.java
RK> M jsf-api/src/javax/faces/convert/IntegerConverter.java
RK> M jsf-api/src/javax/faces/convert/LongConverter.java
RK> M jsf-api/src/javax/faces/convert/NumberConverter.java
RK> M jsf-api/src/javax/faces/convert/ShortConverter.java

ordering mismatch, please check all messages in these classes for
ordering correctness.

RK> M jsf-api/src/javax/faces/validator/DoubleRangeValidator.java

the NOT_IN_RANGE message doesn't mention the label. Can you also please
check that other existing messages mention the label as appropriate?

RK> M jsf-api/src/javax/faces/validator/LengthValidator.java

The diff on this one suffered from the ^M problem. In your revised
change-bundle, can you please rectify it?

RK> M jsf-api/src/javax/faces/validator/LongRangeValidator.java

Ok.

RK> M jsf-api/src/javax/faces/validator/Validator.java

Ok.

RK> M jsf-ri/src/javax/faces/Messages.properties
RK> M jsf-ri/src/javax/faces/Messages_de.properties
RK> M jsf-ri/src/javax/faces/Messages_es.properties
RK> M jsf-ri/src/javax/faces/Messages_fr.properties
RK> M jsf-tools/template-src/MessageFactory.java

I still don't like the idea of using "the last one" as the slot for
the label. In fact, I dislike it so much, I want to propose an
alternate solution. This solution doesn't require changing any of the
converters above (other than what I've already suggested).
java.text.MessageFormat says the number in the {n}

can be 0 - 9.
Rather than the "last" being special, let's just use 9. That way, we
have several chances to add parameters without changing any code
before we run out. To affect this proposal, modify
MessageFactory.getFormattedString() to create a 10 element array where
the element at index 9 is the last element from the params array, and
the first elements of the params array are copied in order at the
beginning of the array. Any intervening elements in the 10 element
array are filled with the empty string. Will this work?

Please produce another change-bundle.

Thanks,

Ed

glassfishrobot · 2005-02-23T09:49:52Z

@edburns said:
status enact

glassfishrobot · 2005-02-24T06:45:41Z

rogerk said:
M jsf-api/build.xml

added entry to create MessageFactory.java for converters
M jsf-api/doc/input-attrs.xml
generated from input-props.xml
M jsf-api/doc/input-props.xml
added "label" attribute
M jsf-api/doc/standard-html-renderkit.xml
generated - includes "label" attribute
M jsf-api/src/javax/faces/convert/BigDecimalConverter.java
M jsf-api/src/javax/faces/convert/BigIntegerConverter.java
M jsf-api/src/javax/faces/convert/BooleanConverter.java
M jsf-api/src/javax/faces/convert/ByteConverter.java
M jsf-api/src/javax/faces/convert/CharacterConverter.java
M jsf-api/src/javax/faces/convert/DateTimeConverter.java
M jsf-api/src/javax/faces/convert/DoubleConverter.java
M jsf-api/src/javax/faces/convert/FloatConverter.java
M jsf-api/src/javax/faces/convert/IntegerConverter.java
M jsf-api/src/javax/faces/convert/LongConverter.java
M jsf-api/src/javax/faces/convert/NumberConverter.java
M jsf-api/src/javax/faces/convert/ShortConverter.java
added message constants; use them in ConverterException(s)
M jsf-api/src/javax/faces/validator/DoubleRangeValidator.java
M jsf-api/src/javax/faces/validator/LengthValidator.java
M jsf-api/src/javax/faces/validator/LongRangeValidator.java
M jsf-api/src/javax/faces/validator/Validator.java
updated javadocs;
include component label in the parameter array for messages
M jsf-ri/src/javax/faces/Messages.properties
M jsf-ri/src/javax/faces/Messages_de.properties
M jsf-ri/src/javax/faces/Messages_es.properties
M jsf-ri/src/javax/faces/Messages_fr.properties
updated to include converter messages;
also included new "label" value placeholder at the beginning
of messages.
M jsf-ri/systest/build-tests.xml
included new test for converter messages
M jsf-ri/systest/src/com/sun/faces/CustomMessages.properties
contains a component label to illustrate the inclusion of the label
from a resource bundle.
M jsf-ri/systest/src/com/sun/faces/jsptest/ConverterTestCase.java
M jsf-ri/systest/src/com/sun/faces/jsptest/ValidatorTestCase.java
included tests for messages
M jsf-ri/systest/web/converter03.jsp
M jsf-tools/template-src/MessageFactory.java
include specialized FacesMessage class (inner) that performs late
binding evaluation for message substitution parameters.

A jsf-ri/systest/web/converter04.jsp
A jsf-ri/systest/web/validator03.jsp

new test pages

glassfishrobot · 2005-02-24T06:47:00Z

rogerk said:
Created an attachment (id=15)
Change bundle for this issue.

glassfishrobot · 2005-02-24T06:47:00Z

File: issue-6.zip.gz
Attached By: rogerk

glassfishrobot · 2005-02-24T07:05:50Z

@edburns said:
Looks good, r=edburns! Close this one!

glassfishrobot · 2005-02-24T07:28:44Z

rogerk said:
checked in.

glassfishrobot · 2009-11-24T07:48:05Z

@edburns said:
Prepare to delete "spec" subcomponent.

glassfishrobot · 2010-03-04T14:09:25Z

@edburns said:
Move all to 1.2

glassfishrobot · 2010-03-04T14:09:25Z

Marked as fixed on Thursday, March 4th 2010, 6:09:25 am

glassfishrobot · 2014-08-01T14:07:21Z

@manfredriem said:
Closing resolved issue out

glassfishrobot · 2017-05-05T04:12:55Z

This issue was imported from java.net JIRA JAVASERVERFACES_SPEC_PUBLIC-6

glassfishrobot closed this as completed Mar 4, 2010

glassfishrobot added Type: New Feature Priority: Major Component: Uncategorized labels May 5, 2017

glassfishrobot added the ERR: Assignee label May 5, 2017

glassfishrobot added this to the 1.2 milestone May 5, 2017

glassfishrobot self-assigned this May 5, 2017

glassfishrobot mentioned this issue May 5, 2017

Create a logo for the JSF Specification #980

Closed

alwin-joseph mentioned this issue Jul 26, 2019

Component / Message Association alwin-joseph/target-test-jsf-issue-migration#6

Closed

eclipse-faces-bot mentioned this issue Aug 6, 2019

Component / Message Association jakartaee/faces#6

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Component / Message Association #6

Component / Message Association #6

glassfishrobot commented Aug 19, 2004

glassfishrobot commented Aug 19, 2004

glassfishrobot commented Aug 19, 2004

glassfishrobot commented Aug 30, 2004

glassfishrobot commented Oct 7, 2004

glassfishrobot commented Jan 10, 2005

glassfishrobot commented Feb 8, 2005

glassfishrobot commented Feb 8, 2005

glassfishrobot commented Feb 8, 2005

glassfishrobot commented Feb 14, 2005

glassfishrobot commented Feb 14, 2005

glassfishrobot commented Feb 14, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 23, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Nov 24, 2009

glassfishrobot commented Mar 4, 2010

glassfishrobot commented Mar 4, 2010

glassfishrobot commented Aug 1, 2014

glassfishrobot commented May 5, 2017

Component / Message Association #6

Component / Message Association #6

Comments

glassfishrobot commented Aug 19, 2004

Environment

Affected Versions

glassfishrobot commented Aug 19, 2004

glassfishrobot commented Aug 19, 2004

glassfishrobot commented Aug 30, 2004

glassfishrobot commented Oct 7, 2004

glassfishrobot commented Jan 10, 2005

glassfishrobot commented Feb 8, 2005

SECTION: Modified Files

glassfishrobot commented Feb 8, 2005

glassfishrobot commented Feb 8, 2005

glassfishrobot commented Feb 14, 2005

SECTION: Modified Files

glassfishrobot commented Feb 14, 2005

glassfishrobot commented Feb 14, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 22, 2005

glassfishrobot commented Feb 23, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Feb 24, 2005

glassfishrobot commented Nov 24, 2009

glassfishrobot commented Mar 4, 2010

glassfishrobot commented Mar 4, 2010

glassfishrobot commented Aug 1, 2014

glassfishrobot commented May 5, 2017