|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IChannelTitle
IChannelTitle is an interface for conveying the title of a channel.
Its current use (as of uPortal 2.5.1) is for marking a @link{ChannelRuntimeProperties} as conveying a dynamic channel title. That is, an @link{IChannel} returning a @link{ChannelRuntimeProperties} that implements IChannelTitle communicates to the framework a desired title for the channel, overriding any title declared at the time of channel publication.
Dynamic channel title capability is implemented in terms of this interface rather than in terms of detection of some particular @link{ChannelRuntimeProperties} subclass so that any existing or new @link{ChannelRuntimeProperties} subclassess can be made dynamically titled. Recommendation for channel implementors: use
Method Summary | |
---|---|
java.lang.String |
getChannelTitle()
Get the desired channel title. |
Method Detail |
---|
java.lang.String getChannelTitle()
null
indicates that the channel is not specifying
a dynamic title and will leave it up to "the uPortal framework" to
provide a title for the channel.
Currently, the fallback behavior is to behave as if the channel hadn't provided an IDynamicChannelTitle at all and use the title specified at channel publication.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |