Package lumis.doui.control.htmleditor

Class CKEditorResource

java.lang.Object

lumis.doui.control.htmleditor.CKEditorResource

@Path("/lumis/doui/control/htmleditor/{serviceInstanceId:[a-fA-F0-9]{32}}")
public class CKEditorResource
extends java.lang.Object

CKEditor Base HREF router.

Since:

14.0.0

Version:

$Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

Constructor Summary

Constructors

Constructor	Description
CKEditorResource()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBusinessContextPropertyValues(java.lang.String property, java.lang.String term)	Returns values known for a business context property that matches the given term.
java.lang.String	getHtmlBlockData(java.lang.String sourceId, java.lang.String fieldId, java.lang.String pk)	Returns the conditions HTML blocks source field.
java.lang.String	getHtmlBlockData(java.lang.String sourceId, java.lang.String fieldId, java.lang.String pk, java.lang.String targetAreaName)	Returns the conditions HTML blocks source field.
Response	getResource(java.lang.String originalPath)	Routes the given path to the appropriate path.
java.lang.String	getWidgetHtml(java.lang.String widgetInstanceId, HttpServletResponse response)	Renders a widget and returns its HTML for use in the CKEditor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CKEditorResource

public CKEditorResource()

Method Detail

getResource

@GET
@Path("/baseHref/{originalPath:.+}")
public Response getResource(@PathParam("originalPath")
                            java.lang.String originalPath)
                     throws PortalException

Routes the given path to the appropriate path.

Parameters:

originalPath - the originalPath

Returns:

a redirect response.

Throws:

PortalException

Since:

14.0.0

getHtmlBlockData

@GET
@Produces("application/json")
@Path("/getHtmlBlockData/{sourceId}/{fieldId}/{pk:[a-fA-F0-9]{32}}")
public java.lang.String getHtmlBlockData(@PathParam("sourceId")
                                         java.lang.String sourceId,
                                         @PathParam("fieldId")
                                         java.lang.String fieldId,
                                         @PathParam("pk")
                                         java.lang.String pk)
                                  throws PortalException,
                                         java.sql.SQLException

Returns the conditions HTML blocks source field.

Parameters:

sourceId - the source identifier.

fieldId - the field identifier.

pk - the primary key source value.

Returns:

the conditions HTML blocks source field.

Throws:

PortalException

java.sql.SQLException

Since:

14.0.0

See Also:

getHtmlBlockData(String, String, String, String)

getHtmlBlockData

@GET
@Produces("application/json")
@Path("/getHtmlBlockData/{sourceId}/{fieldId}/{pk:[a-fA-F0-9]{32}}/{targetAreaName}")
public java.lang.String getHtmlBlockData(@PathParam("sourceId")
                                         java.lang.String sourceId,
                                         @PathParam("fieldId")
                                         java.lang.String fieldId,
                                         @PathParam("pk")
                                         java.lang.String pk,
                                         @PathParam("targetAreaName")
                                         java.lang.String targetAreaName)
                                  throws PortalException,
                                         java.sql.SQLException

Returns the conditions HTML blocks source field.

Parameters:

sourceId - the source identifier.

fieldId - the field identifier.

pk - the primary key source value.

targetAreaName - the target area name.

Returns:

the conditions HTML blocks source field.

Throws:

PortalException

java.sql.SQLException

Since:

17.0.0

getWidgetHtml

@GET
@Produces("text/plain")
@Path("/widgetHtml/{widgetInstanceId:[a-fA-F0-9]{32}}")
public java.lang.String getWidgetHtml(@PathParam("widgetInstanceId")
                                      java.lang.String widgetInstanceId,
                                      @Context
                                      HttpServletResponse response)
                               throws PortalException

Renders a widget and returns its HTML for use in the CKEditor.

Parameters:

widgetInstanceId - the identifier of the widget instance.

response - the HttpServletResponse.

Returns:

the HTML.

Throws:

PortalException

Since:

15.0.0

getBusinessContextPropertyValues

@GET
@Path("businessContextPropertyValues")
@Produces("application/json")
public java.lang.String getBusinessContextPropertyValues(@QueryParam("p")
                                                         java.lang.String property,
                                                         @QueryParam("term")
                                                         java.lang.String term)
                                                  throws PortalException

Returns values known for a business context property that matches the given term.

Parameters:

property - the property key.

term - the term to search for.

Returns:

JSON array with string values.

Throws:

PortalException

Since:

16.0.0