|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GadgetViewFactory
A factory which provides a way to create ViewComponent
s for gadgets. A host
application should use this for embedding individual gadgets in the desired locations by
creating a view and then calling the ViewComponent.writeTo(java.io.Writer)
method.
Method Summary | |
---|---|
boolean |
canRenderInViewType(GadgetState state,
ViewType viewType,
GadgetRequestContext gadgetRequestContext)
Returns true if the gadget represented by state can be rendered with the given ViewType for
the locale specified in the GadgetRequestContext . |
ViewComponent |
createGadgetView(GadgetState state,
View view,
GadgetRequestContext gadgetRequestContext)
Returns a ViewComponent that will render the GadgetState , customizing the view based
on the Locale specified in the GadgetRequestContext and the desired ViewType . |
Method Detail |
---|
ViewComponent createGadgetView(GadgetState state, View view, GadgetRequestContext gadgetRequestContext) throws GadgetParsingException, GadgetRenderingException
Returns a ViewComponent
that will render the GadgetState
, customizing the view based
on the Locale
specified in the GadgetRequestContext
and the desired ViewType
.
This can be used by host applications to place gadgets anywhere they choose.
state
- state of the gadget to be rendered by the ViewComponent
view
- desired View
to use when rendering the gadgetgadgetRequestContext
- context info for this request
to make changes to the gadget state; false
if the gadget is read-only for the current viewer
ViewComponent
that will render the GadgetState
GadgetParsingException
- thrown if there is a problem parsing the gadget spec
GadgetRenderingException
- thrown if the gadget does not define a <Content> section for the
view
boolean canRenderInViewType(GadgetState state, ViewType viewType, GadgetRequestContext gadgetRequestContext) throws GadgetParsingException
true
if the gadget represented by state
can be rendered with the given ViewType
for
the locale
specified in the GadgetRequestContext
.
state
- state of the gadget to check if we can renderviewType
- view type to check the gadget can be rendered ingadgetRequestContext
- the context of this request
true
if the gadget can be rendered with the view
in the locale
, false
otherwise
GadgetParsingException
- thrown if there is a problem parsing the gadget spec
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |