Package com.simplicite.webapp.web

Class ResponsiveExternalObject

java.lang.Object

com.simplicite.util.ExternalObject

com.simplicite.webapp.web.ResponsiveExternalObject

All Implemented Interfaces:

CacheInterface, java.io.Serializable

public class ResponsiveExternalObject
extends ExternalObject

Responsive component external object.
This class returns a simple JavaScript statement that calls a render function passing it the requests parameters.
By default the render statement is <name of the external object>.render(params, data).

See Also:

Serialized Form

Field Summary

Fields inherited from class com.simplicite.util.ExternalObject

DEFAUT_MIME_TYPE

Constructor Summary

Constructors

Constructor	Description
ResponsiveExternalObject()

Method Summary

Modifier and Type	Method	Description
java.lang.String	content(Parameters params)	Get component content hook
java.lang.String	display(Parameters params)	Display method: if called in GET it calls the render function given by the getRenderFunction hook (the HTML body and Javascript code must be configured as resources) if called in POST/PUT/DELETE it calls
java.lang.String[]	getCSSIncludes()	Get CSS stylesheets URLs hook
org.json.JSONObject	getData(Parameters params)	Get data hook
java.lang.String[]	getJSIncludes()	Get Javascript libs URLs hook
java.lang.String	getRenderFunction()	Get render function name hook
java.lang.String	getRenderStatement(Parameters params)	Get render statement hook
boolean	isEmbedded(Parameters params)	Is embedded hook
java.lang.Object	service(Parameters params)	JSON service hook (called in POST/PUT/DELETE)
org.json.JSONObject	serviceBadRequestError()	Service bad request error
org.json.JSONObject	serviceBadRequestError(java.lang.String message)	Service bad request error
org.json.JSONObject	serviceBadRequestError(java.lang.Throwable e)	Service bad request error
org.json.JSONObject	serviceError(int code, java.lang.String message)	Service error response
org.json.JSONObject	serviceInfo(java.lang.String message)	Service info response
org.json.JSONObject	serviceInternalServerError()	Service internal server error
org.json.JSONObject	serviceInternalServerError(java.lang.String message)	Service internal server error
org.json.JSONObject	serviceInternalServerError(java.lang.Throwable e)	Service internal server error

Methods inherited from class com.simplicite.util.ExternalObject

addChartjs, addExtraCSS, addExtraCSS, addExtraJS, addExtraJS, addFullCalendar, addJQPlot, addMarkdown, addMustache, addSharedScript, addVue, appendChartjs, appendCSSInclude, appendCSSIncludes, appendFullCalendar, appendJQPlot, appendJSInclude, appendJSIncludes, appendMarkdown, appendMustache, appendVue, enableGC, evalExpression, garbageCollection, getBooleanParameter, getCacheKey, getClassName, getConsole, getContentDisposition, getCSSResources, getDesc, getDisplay, getDoubleParameter, getExtraCSS, getExtraJS, getFlagParameter, getFloatParameter, getGrant, getHelp, getHTML, getHTMLResources, getHTTPStatus, getIconCode, getId, getImageResources, getIntParameter, getJSResources, getLabel, getLongParameter, getMaxAge, getMimeType, getMIMEType, getModuleId, getModuleName, getName, getObjectParameter, getParameter, getParameter, getResource, getResourceContent, getResourceCSSContent, getResourceCSSURL, getResourceHTMLContent, getResourceHTMLURL, getResourceJSContent, getResourceJSURL, getResourcePDFContent, getResourcePDFURL, getResources, getResourceURL, getRoot, getScriptId, getSharedScripts, getTarget, getURL, hasDecoration, hasJSGlobals, hasJSParameters, hasResources, hasTitle, httpRedirect, invokeAction, invokeAction, invokeAction, invokeAction, isJavaImplemented, isPublic, javascript, lastUsage, prepareExpression, readScript, redirect, removeParameter, removeParameters, sendHttpRedirect, sendJavaScript, sendRedirect, setClassName, setConsole, setContentDisposition, setCSVMIMEType, setDecoration, setDisplay, setGrant, setHelp, setHTML, setHTMLMIMEType, setHTTPStatus, setIconCode, setId, setJavaImplemented, setJSGlobals, setJSONMIMEType, setJSParameters, setLabel, setMaxAge, setMimeType, setMIMEType, setModuleId, setModuleName, setMSExcelMIMEType, setMSPowerPointMIMEType, setMSWordMIMEType, setName, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setPDFMIMEType, setPublic, setResources, setRoot, setScriptId, setTarget, setTextMIMEType, setTitle, setTSVMIMEType, setURL, setUseCalculator, setUseCalendar, setUseCharts, setUseCompletion, setUseHTMLEditor, setUseTreeview, setXMLMIMEType, setYAMLMIMEType, setZIPMIMEType, toJSONObject, toString, unitTests, useCalculator, useCalendar, useCharts, useCompletion, useHTMLEditor, useTreeview

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResponsiveExternalObject

public ResponsiveExternalObject()

Method Detail

getData

public org.json.JSONObject getData(Parameters params)

Get data hook

Parameters:

params - Parameters

Returns:

Data

getRenderFunction

public java.lang.String getRenderFunction()

Get render function name hook

Returns:

Render function (<Object name>.render by default)

getJSIncludes

public java.lang.String[] getJSIncludes()

Get Javascript libs URLs hook

Returns:

List of JS libs URLs

getCSSIncludes

public java.lang.String[] getCSSIncludes()

Get CSS stylesheets URLs hook

Returns:

List of CSS stylesheets URLs

getRenderStatement

public java.lang.String getRenderStatement(Parameters params)

Get render statement hook

Parameters:

params - Parameters

Returns:

Render statement (wraps render function call by default)

serviceInfo

public org.json.JSONObject serviceInfo(java.lang.String message)

Service info response

Parameters:

message - Information message

Returns:

JSON object

serviceError

public org.json.JSONObject serviceError(int code,
                                        java.lang.String message)

Service error response

Parameters:

code - HTTP status

message - Error message

Returns:

JSON object

serviceBadRequestError

public final org.json.JSONObject serviceBadRequestError(java.lang.Throwable e)

Service bad request error

Parameters:

e - Throwable

Returns:

JSON object

serviceBadRequestError

public final org.json.JSONObject serviceBadRequestError()

Service bad request error

Returns:

JSON object

serviceBadRequestError

public final org.json.JSONObject serviceBadRequestError(java.lang.String message)

Service bad request error

Parameters:

message - Message

Returns:

JSON object

serviceInternalServerError

public final org.json.JSONObject serviceInternalServerError(java.lang.Throwable e)

Service internal server error

Parameters:

e - Throwable

Returns:

JSON object

serviceInternalServerError

public final org.json.JSONObject serviceInternalServerError()

Service internal server error

Returns:

JSON object

serviceInternalServerError

public final org.json.JSONObject serviceInternalServerError(java.lang.String message)

Service internal server error

Parameters:

message - Message

Returns:

JSON object

service

public java.lang.Object service(Parameters params)

JSON service hook (called in POST/PUT/DELETE)

Parameters:

params - Parameters

Returns:

JSON object or array or string (bad request error by default)

content

public java.lang.String content(Parameters params)

Get component content hook

Parameters:

params - Parameters

Returns:

HTML content

isEmbedded

public boolean isEmbedded(Parameters params)

Is embedded hook

Parameters:

params - Parameters

Returns:

True if embedded (defaults to the value of the "embedded" parameter)

display

public final java.lang.String display(Parameters params)

Display method:

• if called in GET it calls the render function given by the getRenderFunction hook (the HTML body and Javascript code must be configured as resources)
• if called in POST/PUT/DELETE it calls

Overrides:

display in class ExternalObject

Parameters:

params - Parameters

Returns:

Content to display (either as String for text content or as byte array for binary content)