You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@myfaces.apache.org by Adam Winer <aw...@gmail.com> on 2007/07/17 19:38:56 UTC

[Trinidad] Put naming container info in tagdoc?

It's not always obvious which components in Trinidad are
naming containers, so I was thinking it'd be good to add
naming container information to our tagdoc:

For example, we currently have:

Tag name: <tr:breadCrumbs>
UIComponent class:
org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs

but could autogenerate:

Tag name: <tr:breadCrumbs>
UIComponent class:
org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
Naming container: yes, when identifying a child, you must include its
  ID in partialTriggers, calls to findComponent() etc.

Sound good?

-- Adam

Re: [Trinidad] Put naming container info in tagdoc?

Posted by Gabrielle Crawford <ga...@oracle.com>.

+1.

Matt Cooper wrote:
> +1:  I think it is a very common problem that people run into.  Sure 
> you can look up the component class being used by the tag and then 
> find its JavaDoc and then look at the top to see if it contains 
> NamingContainer but being such a common task, I think it would be very 
> helpful to indicate in the tag docs.
>
> Thank you,
> Matt
>
> On 7/17/07, *Simon Lessard* <simon.lessard.3@gmail.com 
> <ma...@gmail.com>> wrote:
>
>     +0.
>
>     On one side, this would directly link the tag with the component
>     class. I know there isn't much chance that it would change, but
>     wasn't it the point of component type to indirect such info ?
>
>     On the other hand though, I'd find that info useful, because I
>     wouldn't have to browse the component API doc to see what
>     interfaces are implemented.
>
>
>     Regards,
>
>     ~ Simon
>
>
>     On 7/17/07, *Matthias Wessendorf* < matzew@apache.org
>     <ma...@apache.org>> wrote:
>
>         why not,
>         the "more" documentation, the better :-)
>
>         On 7/17/07, Adam Winer <awiner@gmail.com
>         <ma...@gmail.com> > wrote:
>         > It's not always obvious which components in Trinidad are
>         > naming containers, so I was thinking it'd be good to add
>         > naming container information to our tagdoc:
>         >
>         > For example, we currently have:
>         >
>         > Tag name: <tr:breadCrumbs>
>         > UIComponent class:
>         > org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
>         > Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
>         >
>         > but could autogenerate:
>         >
>         > Tag name: <tr:breadCrumbs>
>         > UIComponent class:
>         > org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
>         > Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
>         > Naming container: yes, when identifying a child, you must
>         include its
>         >   ID in partialTriggers, calls to findComponent() etc.
>         >
>         > Sound good?
>         >
>         > -- Adam
>         >
>
>
>         --
>         Matthias Wessendorf
>
>         further stuff:
>         blog: http://matthiaswessendorf.wordpress.com/
>         mail: matzew-at-apache-dot-org
>
>
>

Re: [Trinidad] Put naming container info in tagdoc?

Posted by Matt Cooper <ma...@gmail.com>.

+1:  I think it is a very common problem that people run into.  Sure you can
look up the component class being used by the tag and then find its JavaDoc
and then look at the top to see if it contains NamingContainer but being
such a common task, I think it would be very helpful to indicate in the tag
docs.

Thank you,
Matt

On 7/17/07, Simon Lessard <si...@gmail.com> wrote:
>
> +0.
>
> On one side, this would directly link the tag with the component class. I
> know there isn't much chance that it would change, but wasn't it the point
> of component type to indirect such info ?
>
> On the other hand though, I'd find that info useful, because I wouldn't
> have to browse the component API doc to see what interfaces are implemented.
>
>
> Regards,
>
> ~ Simon
>
> On 7/17/07, Matthias Wessendorf <ma...@apache.org> wrote:
> >
> > why not,
> > the "more" documentation, the better :-)
> >
> > On 7/17/07, Adam Winer <aw...@gmail.com> wrote:
> > > It's not always obvious which components in Trinidad are
> > > naming containers, so I was thinking it'd be good to add
> > > naming container information to our tagdoc:
> > >
> > > For example, we currently have:
> > >
> > > Tag name: <tr:breadCrumbs>
> > > UIComponent class:
> > > org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
> > > Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
> > >
> > > but could autogenerate:
> > >
> > > Tag name: <tr:breadCrumbs>
> > > UIComponent class:
> > > org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
> > > Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
> > > Naming container: yes, when identifying a child, you must include its
> > >   ID in partialTriggers, calls to findComponent() etc.
> > >
> > > Sound good?
> > >
> > > -- Adam
> > >
> >
> >
> > --
> > Matthias Wessendorf
> >
> > further stuff:
> > blog: http://matthiaswessendorf.wordpress.com/
> > mail: matzew-at-apache-dot-org
> >
>
>

Re: [Trinidad] Put naming container info in tagdoc?

Posted by Simon Lessard <si...@gmail.com>.

+0.

On one side, this would directly link the tag with the component class. I
know there isn't much chance that it would change, but wasn't it the point
of component type to indirect such info ?

On the other hand though, I'd find that info useful, because I wouldn't have
to browse the component API doc to see what interfaces are implemented.


Regards,

~ Simon

On 7/17/07, Matthias Wessendorf <ma...@apache.org> wrote:
>
> why not,
> the "more" documentation, the better :-)
>
> On 7/17/07, Adam Winer <aw...@gmail.com> wrote:
> > It's not always obvious which components in Trinidad are
> > naming containers, so I was thinking it'd be good to add
> > naming container information to our tagdoc:
> >
> > For example, we currently have:
> >
> > Tag name: <tr:breadCrumbs>
> > UIComponent class:
> > org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
> > Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
> >
> > but could autogenerate:
> >
> > Tag name: <tr:breadCrumbs>
> > UIComponent class:
> > org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
> > Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
> > Naming container: yes, when identifying a child, you must include its
> >   ID in partialTriggers, calls to findComponent() etc.
> >
> > Sound good?
> >
> > -- Adam
> >
>
>
> --
> Matthias Wessendorf
>
> further stuff:
> blog: http://matthiaswessendorf.wordpress.com/
> mail: matzew-at-apache-dot-org
>

Re: [Trinidad] Put naming container info in tagdoc?

Posted by Matthias Wessendorf <ma...@apache.org>.

why not,
the "more" documentation, the better :-)

On 7/17/07, Adam Winer <aw...@gmail.com> wrote:
> It's not always obvious which components in Trinidad are
> naming containers, so I was thinking it'd be good to add
> naming container information to our tagdoc:
>
> For example, we currently have:
>
> Tag name: <tr:breadCrumbs>
> UIComponent class:
> org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
> Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
>
> but could autogenerate:
>
> Tag name: <tr:breadCrumbs>
> UIComponent class:
> org.apache.myfaces.trinidad.component.core.nav.CoreBreadCrumbs
> Component type: org.apache.myfaces.trinidad.CoreBreadCrumbs
> Naming container: yes, when identifying a child, you must include its
>   ID in partialTriggers, calls to findComponent() etc.
>
> Sound good?
>
> -- Adam
>


-- 
Matthias Wessendorf

further stuff:
blog: http://matthiaswessendorf.wordpress.com/
mail: matzew-at-apache-dot-org