lumis.doui.control.selectchannel
Class SelectChannelOrChannelTemplateControl

java.lang.Object
  lumis.doui.control.Control
      lumis.doui.control.DataControl
          lumis.doui.control.DataBoundControl
              lumis.doui.control.selectchannel.SelectChannelOrChannelTemplateControl

All Implemented Interfaces:

Observer, VariableResolver, IClientSideReadableControl, IControl, IDataBoundControl, IDataControl, IRenderer

Direct Known Subclasses:

SelectChannelControl, SelectChannelControl, SelectChannelOrChannelTemplateControlWithCustomCallbackFunction, SelectChannelTemplateControl

public class SelectChannelOrChannelTemplateControl
extends DataBoundControl
implements IClientSideReadableControl

Control for selecting a channel or a channel template.

Since:

4.0.0

Field Summary

Fields inherited from class lumis.doui.control.DataControl

FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet

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

SelectChannelOrChannelTemplateControl()

Method Summary

protected void	autoAddValidators()
void	buildSubControls()
protected String	getCallbackScriptFunctionImplementation() Returns the callback function implementation. The function signature is function (channelId, channelName, pageId, pageName).
protected String	getDisplayValue() Returns the name to be displayed for the user.
String	getInterfaceId()
protected String	getSelectedChannelId() Returns the selected channel identifier.
void	setRenderData()

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getUnboundedConverter, init, loadFromRequest, setDefaultValue, setRawValue, setReload, setSourceParameter, setSourceParameters, setsSourceParameters, setValid, setValueFromSource, setValueFromSource, update

Methods inherited from class lumis.doui.control.DataControl

convertValueToControlValue, getConverter, getDataType, getDefaultValue, getParameterValue, getProcessActionIds, getRequestParameterName, getValue, getValue, getValueClass, initProcessActionIds, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getControlResource, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionImplementation, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, getStringsToLocalize, getType, getValidationScript, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setRuntimeAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IClientSideReadableControl

getScriptGetValues, getScriptGetValuesRegistration

Methods inherited from interface lumis.doui.control.IDataControl

getConverter, getProcessActionIds, getValue, getValue, setProcessActionHandlerParameters, setValue

Methods inherited from interface lumis.doui.control.IControl

createContainer, disconnect, getChildControls, getControlResource, getId, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes

Methods inherited from interface lumis.doui.render.IRenderer

getResources, getSourceContext

Constructor Detail

SelectChannelOrChannelTemplateControl

public SelectChannelOrChannelTemplateControl()

Method Detail

getInterfaceId

public String getInterfaceId()

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl

Throws:

PortalException

getCallbackScriptFunctionImplementation

protected String getCallbackScriptFunctionImplementation()

Returns the callback function implementation.
The function signature is function (channelId, channelName, pageId, pageName).

Returns:

the callback function implementation.

Since:

6.2.0

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl

Throws:

PortalException

getDisplayValue

protected String getDisplayValue()
                          throws PortalException

Returns the name to be displayed for the user.

Returns:

the name to be displayed for the user.

Throws:

PortalException

Since:

4.2.0

getSelectedChannelId

protected String getSelectedChannelId()
                               throws PortalException

Returns the selected channel identifier.

Returns:

the selected channel identifier.

Throws:

PortalException

Since:

4.2.0

autoAddValidators

protected void autoAddValidators()
                          throws PortalException

Overrides:

autoAddValidators in class DataBoundControl

Throws:

PortalException