tapestry-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Lukasz Jazgar (JIRA)" <j...@apache.org>
Subject [jira] Commented: (TAP5-737) Parameter "translate" of TextField is specified as required, but it's realy not required
Date Thu, 04 Jun 2009 18:13:07 GMT

    [ https://issues.apache.org/jira/browse/TAP5-737?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12716350#action_12716350
] 

Lukasz Jazgar commented on TAP5-737:
------------------------------------


http://tapestry.apache.org/tapestry5.1/apidocs/org/apache/tapestry5/annotations/Parameter.html#required()

Required:
"If true, the parameter is required and and must be bound. If false (the default), then the
parameter is optional."

I would agree with you, if there would be written: "If true, the parameter is required, what
means it must be bound, explicitly by user or internally by component.".
But there is "required AND bound".

"Required" according to your interpretation is completly useless, if it's  treated as specification
of external interface of component.
This flag take part in validating parameter somewhere inside initialization process (after
evaluating defaults) of component.

I see need to add additional attribute to Parameter annotation, which would determine external
interface of components.
This new attribute could be used
* to generate documentation of components
* by IDE plugins to validate and autocomplete templates

Anyway, documentation of @Parameter.required and "Required" flag in components reference should
be more precise.



> Parameter "translate" of TextField is specified as required, but it's realy not required
> ----------------------------------------------------------------------------------------
>
>                 Key: TAP5-737
>                 URL: https://issues.apache.org/jira/browse/TAP5-737
>             Project: Tapestry 5
>          Issue Type: Bug
>          Components: tapestry-core
>    Affects Versions: 5.1.0.5
>            Reporter: Lukasz Jazgar
>            Priority: Minor
>
> Components TextField, TextArea and PasswordField have parameter "translate", which is
specified by annotation and in documentation as required.
> This parameter should not be required and it isn't really. 
> Even in examples of using TextField parameter "translate" is not used (http://tapestry.apache.org/tapestry5.1/tapestry-core/ref/org/apache/tapestry5/corelib/components/TextField.html).
> Specification in documentation, specification in annotations,  examples and real behaviour
should be consistent.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message