Package lumis.content.control.publishtoprincipals

Class PublishToPrincipalsControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.DataControl

lumis.doui.control.DataBoundControl<ContentTableSource>

lumis.content.control.publishtoprincipals.PublishToPrincipalsControl

All Implemented Interfaces:

Observer, VariableResolver, IControl, IDataBoundControl, IDataControl, IRenderer

public class PublishToPrincipalsControl
extends DataBoundControl<ContentTableSource>

Control that renders interface to publish content to principals

Since:

4.0.0

Version:

$Revision: 20857 $ $Date: 2017-12-27 13:27:30 -0200 (Wed, 27 Dec 2017) $

Field Summary

Fields

Modifier and Type	Field	Description
protected ButtonControl	buttonSubControl
protected int	numPrincipals
protected String	primaryKeyFieldId
protected static String	PUBLISH_TO_PRINCIPALS_INTERFACE_ID
protected IDataControl	valueSubControl

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, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor	Description
PublishToPrincipalsControl()

Method Summary

Modifier and Type	Method	Description
void	buildSubControls()
IResource	getControlResource()
IDataControlRequestHelpDefinition	getRequestHelpDefinition()	Returns the request parameters help definition.
protected Map<String,String>	getStringsToLocalize()
void	init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
void	setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)	Sets the control value as a process action handler parameter.
void	setRenderData()
protected void	setValueFromSource(ContentTableSource source)	Reads the value corresponding to the current control from the control source.

Methods inherited from class lumis.doui.control.DataBoundControl

autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getSourceContext, getUnboundedConverter, loadFromRequest, setDefaultValue, setRawValue, setReload, setSourceParameter, setValid, 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, setSourceParameter, setSourceParameters, setTrim, setValue, valueIsArray

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getType, getValidationScript, getWindowProperties, getWindowProperties, isRequired, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, 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.IControl

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

Methods inherited from interface lumis.doui.control.IDataControl

getConverter, getProcessActionIds, getValue, getValue, setValue

Methods inherited from interface lumis.doui.render.IRenderer

getResources

Field Detail

PUBLISH_TO_PRINCIPALS_INTERFACE_ID

protected static final String PUBLISH_TO_PRINCIPALS_INTERFACE_ID

See Also:

Constant Field Values

primaryKeyFieldId

protected String primaryKeyFieldId

numPrincipals

protected int numPrincipals

valueSubControl

protected IDataControl valueSubControl

buttonSubControl

protected ButtonControl buttonSubControl

Constructor Detail

PublishToPrincipalsControl

public PublishToPrincipalsControl()

Method Detail

init

public void init(Node controlDefinitionNode,
                 ControlContainer controlContainer,
                 IControl parentControl)
          throws PortalException

Specified by:

init in interface IControl

Overrides:

init in class DataBoundControl<ContentTableSource>

Throws:

PortalException

setValueFromSource

protected void setValueFromSource(ContentTableSource source)
                           throws PortalException

Description copied from class: DataBoundControl

Reads the value corresponding to the current control from the control source. By default the value that is taken from the source is from the first row of the source tabular data. However, if the control has the dataRow specified, the value taken from the source tabular data corresponds to specified row.

Overrides:

setValueFromSource in class DataBoundControl<ContentTableSource>

Throws:

PortalException

buildSubControls

public void buildSubControls()
                      throws PortalException

Specified by:

buildSubControls in interface IControl

Overrides:

buildSubControls in class DataBoundControl<ContentTableSource>

Throws:

PortalException

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class DataBoundControl<ContentTableSource>

Throws:

PortalException

getControlResource

public IResource getControlResource()
                             throws PortalException

Specified by:

getControlResource in interface IControl

Overrides:

getControlResource in class Control

Throws:

PortalException

setProcessActionHandlerParameters

public void setProcessActionHandlerParameters(IProcessActionHandler processActionHandler)
                                       throws PortalException

Description copied from class: DataControl

Sets the control value as a process action handler parameter.

Specified by:

setProcessActionHandlerParameters in interface IDataControl

Overrides:

setProcessActionHandlerParameters in class DataControl

Throws:

PortalException

getStringsToLocalize

protected Map<String,String> getStringsToLocalize()

Overrides:

getStringsToLocalize in class Control

getRequestHelpDefinition

public IDataControlRequestHelpDefinition getRequestHelpDefinition()
                                                           throws PortalException

Description copied from interface: IDataControl

Returns the request parameters help definition. Used in process action REST API help. Must not return null.

Specified by:

getRequestHelpDefinition in interface IDataControl

Overrides:

getRequestHelpDefinition in class DataBoundControl<ContentTableSource>

Returns:

the request parameters help definition. Used in process action REST API help. Must not return null.

Throws:

PortalException