Package lumis.portal.servlet

Interface IUniqueWriterController

public interface IUniqueWriterController

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IUniqueWriterController.UniqueWriterControllerListener	The interface that listeners must implement.

Method Summary

Modifier and Type	Method	Description
void	addTracedKey(java.lang.String key)	Add a key to #tracedItems.
java.lang.String	getHeadEndMarkers()	Returns the head end markers (or null if there's no marker to be inserted).
java.lang.String	getHeadStartMarkers()	Returns the head start markers (or null if there's no marker to be inserted).
java.lang.String	getStringToLocallyWrite(java.lang.String key, java.lang.String text)	Returns the string to be written locally (inline).
java.util.Set<java.lang.String>	getUniqueKeys()	Returns the unique keys used.
java.util.List<java.lang.String>	getUntracedKeys()	A list containing all items from getUniqueKeys() without the items present in #tracedItems.
java.lang.String	processHtml(java.lang.String html, boolean isServerSide)	Deprecated. since 8.2.0 replaced by processHtml(String, boolean, IPageWebResourceRenderRequest).
java.lang.String	processHtml(java.lang.String html, boolean isServerSide, IPageWebResourceRenderRequest renderRequest)	Process the HTML replacing the found markers for their text fragment accordingly.
java.lang.String	processHtml(java.lang.String html, java.util.Set<java.lang.String> usedKeys, boolean isServerSide, IPageWebResourceRenderRequest renderRequest)	Process the HTML replacing the found markers for their text fragment accordingly.
void	removeListener()	Removes this unique writer controller listener.
void	setListener(IUniqueWriterController.UniqueWriterControllerListener listener)	Sets this unique writer controller listener.
void	writeHead(java.lang.String key, java.lang.String text, PortalPrintWriter.WritePosition itemPosition)	Inserts the item to be written in head.

Method Detail

getStringToLocallyWrite

java.lang.String getStringToLocallyWrite(java.lang.String key,
                                         java.lang.String text)

Returns the string to be written locally (inline).

Parameters:

key - the unique key.

text - the text fragment.

Returns:

the string to be written locally (inline).

Since:

7.0.0

writeHead

void writeHead(java.lang.String key,
               java.lang.String text,
               PortalPrintWriter.WritePosition itemPosition)

Inserts the item to be written in head.

Parameters:

key - the unique key.

text - the text fragment.

itemPosition - the item position.

Throws:

java.lang.IllegalArgumentException - if the itemPosition parameter is null or is not any of PortalPrintWriter.WritePosition.HEAD_START or PortalPrintWriter.WritePosition.HEAD_END.

Since:

7.0.0

processHtml

@Deprecated
java.lang.String processHtml(java.lang.String html,
                             boolean isServerSide)
                      throws PortalException

Deprecated.

since 8.2.0 replaced by processHtml(String, boolean, IPageWebResourceRenderRequest).

Process the HTML replacing the found markers for their text fragment accordingly.

Parameters:

html - the HTML to be processed.

renderRequest -

Returns:

the processed HTML.

Throws:

PortalException

Since:

7.0.0

processHtml

java.lang.String processHtml(java.lang.String html,
                             boolean isServerSide,
                             IPageWebResourceRenderRequest renderRequest)
                      throws PortalException

Process the HTML replacing the found markers for their text fragment accordingly.

Parameters:

html - the HTML to be processed.

renderRequest -

Returns:

the processed HTML.

Throws:

PortalException

Since:

8.2.0

processHtml

java.lang.String processHtml(java.lang.String html,
                             java.util.Set<java.lang.String> usedKeys,
                             boolean isServerSide,
                             IPageWebResourceRenderRequest renderRequest)
                      throws PortalException

Process the HTML replacing the found markers for their text fragment accordingly.

Parameters:

html - the HTML to be processed.

usedKeys - the used keys that will not be processed.

Returns:

the processed HTML.

Throws:

PortalException

Since:

8.2.0

getHeadStartMarkers

java.lang.String getHeadStartMarkers()

Returns the head start markers (or null if there's no marker to be inserted).

Returns:

the head start markers (or null if there's no marker to be inserted).

Since:

7.0.0

getHeadEndMarkers

java.lang.String getHeadEndMarkers()

Returns the head end markers (or null if there's no marker to be inserted).

Returns:

the head end markers (or null if there's no marker to be inserted).

Since:

7.0.0

getUniqueKeys

java.util.Set<java.lang.String> getUniqueKeys()

Returns the unique keys used.

Returns:

the unique keys used.

Since:

7.0.0

setListener

void setListener(IUniqueWriterController.UniqueWriterControllerListener listener)

Sets this unique writer controller listener.

Parameters:

listener - the listener.

Since:

7.1.0

removeListener

void removeListener()

Removes this unique writer controller listener.

Since:

7.1.0

getUntracedKeys

java.util.List<java.lang.String> getUntracedKeys()

A list containing all items from getUniqueKeys() without the items present in #tracedItems.

Returns:

Since:

8.1.0

addTracedKey

void addTracedKey(java.lang.String key)

Add a key to #tracedItems. The list is used by getUntracedKeys() to return getUniqueKeys() without the keys present in #tracedItems.

Parameters:

key - The key to be added to the list.

Since:

8.1.0