|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicSpi public interface UserFormat
Provides a format to display a user on screen. This may be simply the user's full name surrounded by a link to the user's profile, or something more advanced such as the user's name and profile picture.
UserFormatModuleDescriptor
,
UserFormats
Field Summary | |
---|---|
static String |
VIEW_TEMPLATE
The default velocity template name that is used to render the view. |
Method Summary | |
---|---|
String |
format(String userkey,
String id)
Renders the formatted user for a given section on the screen. |
String |
format(String userkey,
String id,
Map<String,Object> params)
Renders the formatted user for a given section on the screen. |
Field Detail |
---|
static final String VIEW_TEMPLATE
Method Detail |
---|
String format(String userkey, String id)
userkey
- the user's userkey to format.id
- A value providing extra context to the rendering process.
String format(String userkey, String id, Map<String,Object> params)
userkey
- the user's userkey to format.id
- A value providing extra context to the rendering process.params
- Additional context to pass to the renderer
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |