lumis.doui.control.include
Class IncludeControl

java.lang.Object
  lumis.doui.control.Control
      lumis.doui.control.include.IncludeControl

All Implemented Interfaces:

VariableResolver, IControl

public class IncludeControl
extends Control

Includes a file present in the web application. The path of the file to be added, relative to the web application root, is specified in a page attribute.

Example use using outputHtml mode:

<control:lum_include page="example.xml" mode="outputHtml" /> xml data available for xsl rendering: <control id="8A488A32392C102C01393063EAAF41CE" mode="outputHtml" page="example.xml" type="lum_include"> <data> <!-- here will be the HTML data from the included file, as the text content of the data element. --> </data> </control>

Example use using renderData mode: <control:lum_include page="example.xml" mode="renderData" /> xml data available for xsl rendering: <control id="8A488A32392C102C01393063EAAF41CE" mode="renderData" page="example.xml" type="lum_include"> <data> <!-- here will be the XML data from the included file, as part of the render data DOM, becoming a child of the data element. --> </data> </control>

Since:

7.0.0

Field Summary

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

IncludeControl()

Method Summary

void	setRenderData()

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, buildSubControls, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getRuntimeDefaultSource, getScriptActionValidation, getSourceContext, getStringsToLocalize, getType, getValidationScript, getWindowProperties, init, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setRuntimeAttributes, setValid

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeControl

public IncludeControl()

Method Detail

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class Control

Throws:

PortalException