Usages
- Used to extend types of pages/UI elements available in Userview Builder.
- A useable Userview Menu plugin must extends org.joget.apps.userview.model.UserviewMenu abstract class.
Abstract Class
org.joget.apps.userview.model.UserviewMenu
- Under wflow-core module
- Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
- Implemented org.joget.plugin.property.model.PropertyEditable. Please refer to Plugin Base Abstract Class and Interface.
- A base abstract class to develop a Userview Menu plugin.
Field Detail
Constants
REDIRECT_URL_PROPERTY
public static final String REDIRECT_URL_PROPERTY = "userviewRedirectUrl";
Property key to set a url for redirection.
REDIRECT_PARENT_PROPERTY
public static final String REDIRECT_PARENT_PROPERTY = "userviewRedirectParent";
Property key to set the redirection target to parent window. The property expecting "true" or "false" as value.
ALERT_MESSAGE_PROPERTY
public static final String ALERT_MESSAGE_PROPERTY = "userviewAlertMessage";
Property key to set a alert message to show when a page loaded.
Method Detail
Abstract Methods
getCategory
public abstract String getCategory()
Category to be displayed in Userview Builder palette
getIcon
public abstract String getIcon()
Icon path to be displayed in Userview Builder palette
getRenderPage
public abstract String getRenderPage()
Get render HTML template for UI
isHomePageSupported
public abstract boolean isHomePageSupported()
Used to determine this menu item can used as home page or not.
getDecoratedMenu
public abstract String getDecoratedMenu()
Get Decorated menu HTML for rendering.
Overridable Methods
getMenu
public String getMenu()
Get menu html for rendering. It will call getDecoratedMenu method to retrieve the menu HTML. If empty value is return, a default menu HTML will be generated based on getURL method and "label" property.
getJspPage
public String getJspPage()
Get path of JSP file to render the HTML template. If this value is not NULL, value returned by getRenderPage will be ignored.
It is used to use the system predefined template for rendering. Options are as following:
- userview/plugin/datalist.jsp
- userview/plugin/form.jsp
- userview/plugin/runProcess.jsp
- userview/plugin/unauthorized.jsp
Utility Methods
getUrl
public String getUrl()
setUrl
public void setUrl(String url)
getKey
public String getKey()
setKey
public void setKey(String key)
getRequestParameters
public java.util.Map getRequestParameters()
Gets request parameters
setRequestParameters
public void setRequestParameters(java.util.Map requestParameters)
Sets request parameters
getRequestParameter
public java.lang.Object getRequestParameter(java.lang.String requestParameter)
Convenience method to get a parameter value
getRequestParameterString
public java.lang.String getRequestParameterString(java.lang.String requestParameter)
Convenience method to get a parameter String value.
Return Empty string instead of NULL.
getReadyJspPage
public String getReadyJspPage()
getReadyRenderPage
public String getReadyRenderPage()
getUserview
public Userview getUserview()
setUserview
public void setUserview(Userview userview)
setRedirectUrl
public void setRedirectUrl(String redirectUrl)
setRedirectUrl
public void setRedirectUrl(String redirectUrl, boolean redirectToParent)
setAlertMessage
public void setAlertMessage(String message)
Plugin Properties Options
- Please refer to Plugin Properties Options for more information.
Tutorials
- Not available right now
Related Community Plugins
- Not available right now