To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Registers a JS function and template to render into a named section of an admin or website page, created by PortletMappingBuilder.build. The portlet section name is matched against the page's requested section as a regular expression, so a single mapping can target several related sections at once.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| enabled | boolean | Whether this portlet is currently rendered into its section. |
| function | String | Name of the JS function called to prepare this portlet before it is rendered, when the mapping was built with a function name rather than a function reference. |
| functionPtr | VarArgFunction | Direct reference to the JS function called to prepare this portlet before it is rendered, when the mapping was built with a function reference rather than a function name. |
| portletSection | String | Regular expression matched against the page section name this portlet renders into. |
| sectionRegex | Pattern | Compiled regular expression form of the portlet section, lazily compiled from getPortletSection on first use and cached for subsequent calls. |
| sectionResolvers | Map<String,Object> | Extra resolver values keyed by group name, made available to the portlet's template when rendering. |
| templatePath | String | Repository path of the template that renders this portlet's content. |
Methods
getPortletSection()
Returns: String
Regular expression matched against the page section name this portlet renders into.
getSectionResolvers()
Returns: Map<String,Object>
Extra resolver values keyed by group name, made available to the portlet's template when rendering.
isEnabled()
Returns: boolean
Whether this portlet is currently rendered into its section.
getTemplatePath()
Returns: String
Repository path of the template that renders this portlet's content.
getFunction()
Returns: String
Name of the JS function called to prepare this portlet before it is rendered, when the mapping was built with a function name rather than a function reference.
getFunctionPtr()
Returns: VarArgFunction
Direct reference to the JS function called to prepare this portlet before it is rendered, when the mapping was built with a function reference rather than a function name.
getSectionRegex()
Returns: Pattern
Compiled regular expression form of the portlet section, lazily compiled from getPortletSection on first use and cached for subsequent calls.
© 2025 Kademi Ltd