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()
getIcon
public abstract String getIcon()
getRenderPage
public abstract String getRenderPage()
isHomePageSupported
public abstract boolean isHomePageSupported()
getDecoratedMenu
public abstract String getDecoratedMenu()
Overridable Methods
getMenu
public String getMenu()
getJspPage
public String getJspPage()
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