lumis.doui.control

Class SourceBoundControl<S extends Source<?>>

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.SourceBoundControl<S>

Type Parameters:

S - the source type.

All Implemented Interfaces:

VariableResolver, IControl

Direct Known Subclasses:

AutoAdministrationListButtonsControl, AutoLayoutAdministrationListControl, AutoLayoutDetailsControl, AutoLayoutFieldsControl, AutoLayoutGenericContentAssociationControl, AutoLayoutLanguageInformationControl, AutoLayoutListControl, AutoLayoutMetaDataInformationControl, AutoLayoutPropertyPageControl, AutoLayoutPublishingInformationControl, AutoLayoutPublishToSocialNetworksAdministrationListControl, AutoLayoutSeoInformationControl, AutoLayoutTagInformationControl, BannerControl, ButtonControl, ChatHistoryControl, FilterControl, FiltersControl, ForumButtonVisibilityControl, LockedMessageControl, PagePersonalizationWidgetUsedByControl, SourceFieldBoundControl

public abstract class SourceBoundControl<S extends Source<?>>
extends Control

Control that may be bound to a Source.

Since:

10.4.0

Version:

$Revision: 21230 $ $Date: 2018-04-24 22:07:57 +0000 (Tue, 24 Apr 2018) $

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, 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 and Description
SourceBoundControl()

Method Summary

Modifier and Type	Method and Description
protected Source<?>	getRuntimeDefaultSource() Returns default source to use in the context of the current control when evaluating runtime attributes.
S	getSource() Returns the source bound to to this source bound control.
ISourceContext	getSourceContext()

Methods inherited from class lumis.doui.control.Control

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceBoundControl

public SourceBoundControl()

Method Detail

getSource

public S getSource()
            throws PortalException

Returns the source bound to to this source bound control.

Returns:

the source or null if this control is not bound to any source.

Throws:

PortalObjectNotFoundException - if the sourceId defined in the control does not exist.

PortalException

Since:

10.4.0

getRuntimeDefaultSource

protected Source<?> getRuntimeDefaultSource()

Description copied from class: Control

Returns default source to use in the context of the current control when evaluating runtime attributes.

Overrides:

getRuntimeDefaultSource in class Control

Returns:

the default source, or null if there is no source.

getSourceContext

public ISourceContext getSourceContext()

Overrides:

getSourceContext in class Control