lumis.doui.control

Interface IControl

All Known Subinterfaces:

IDataBoundControl, IDataControl, IErrorSummaryControl, IValidatorControl

All Known Implementing Classes:

AccessControlButton, AccessErrorMessageTranslator, AccountServiceInstancePaneControl, ActivityStreamConfigurationInfoControl, AddButton2Control, AddButtonControl, AddDynamicListSourceControl, AdministrationListControl, AdminMemberConditionalRenderControl, AdvancedTabularDataControl, AnnouncementTabularDataControl, AnswersAutoLayoutFieldsControl, AnswersAutoLayoutFieldsControl, AreaTagsControl, AssociationTabularDataControl, AsyncProgressControl, AutoAdministrationBreadCrumbTreeItemControl, AutoAdministrationListButtonsControl, AutoContentAdministrationListButtonsControl, AutoEmbeddedInterfaceStandardButtonsControl, AutoInterfaceStandardButtonsControl, AutoLayoutAdministrationListControl, AutoLayoutAssociationInformationControl, AutoLayoutCategorizationAssociationControl, AutoLayoutContentAdministrationListControl, AutoLayoutContentDetailsControl, AutoLayoutContentEmbeddedPropertyPageControl, AutoLayoutContentFieldsControl, AutoLayoutContentListControl, AutoLayoutContentPropertyPageControl, AutoLayoutContentQuickListControl, AutoLayoutDetailsControl, AutoLayoutEmbeddedPropertyPageControl, AutoLayoutFieldControl, AutoLayoutFieldsControl, AutoLayoutGenericAssociationInformationControl, AutoLayoutGenericContentAssociationControl, AutoLayoutLanguageInformationControl, AutoLayoutListControl, AutoLayoutMetaDataInformationControl, AutoLayoutPropertyPageControl, AutoLayoutPublishingInformationControl, AutoLayoutPublishToSocialNetworksAdministrationListControl, AutoLayoutQuickListControl, AutoLayoutSeoInformationControl, AutoLayoutTagInformationControl, AutoLayoutWorkflowInformationControl, AutoPopupInterfaceStandardButtonsControl, AutoRefreshControl, BannerControl, BusinessContextForCacheAdvancedTabularDataControl, ButtonControl, CalendarControl, CallEditInterfaceScriptControl, CallLockContentScriptControl, CallPreviewInterfaceScriptControl, CallVersionsInterfaceScriptControl, CancelButtonControl, ChannelAclControl, ChannelInheritedPageTemplateControl, ChannelWebsiteChanceCheckControl, ChatHistoryControl, ChatMessageListControl, ChatSendMessageControl, CheckBoxControl, CheckBoxListControl, CommentAreaListControl, CommentsAddControl, CommentsControl, CommunityTabularDataControl, ConditionalRenderControl, ConfigurationTagsControl, ConfigureButtonControl, ConsumerConfigurationInterfaceDropDownListControl, ConsumerConfigurationInterfaceVerificationControl, ContentAnalyticsButtonControl, ContentIdHolderControl, ContentPickerControl, Control, ControlGroupControl, CurrentContentLocaleIdControl, CustomerExperienceCommonsControl, CustomInputHiddenControl, CustomInputTextAreaControl, DataBoundControl, DataControl, DataGridControl, DateCompareValidatorControl, DateDataTypeValidatorControl, DateTimePickerControl, DefaultPageTemplateControl, DeleteButtonControl, DetailsControl, DocumentParentFilterControl, DocumentPickerControl, DropDownListControl, DynamicListControl, EditButton2Control, EditButtonControl, EditServiceInstanceTabbedControl, EmailControl, EmailValidatorControl, EnviromentPropertiesControl, ErrorSummaryControl, EventAnalyticsControl, ExecuteScriptControl, FCKEditorPopUpFixerControl, FieldsControl, FileListControl, FileNameValidatorControl, FileSizeValidatorControl, FilesPickerControl, FileSystemTabularData, FileUploadControl, FilterControl, FiltersControl, FilterUniqueIdValidator, FlowEditorControl, FollowButtonControl, FormControl, ForumButtonVisibilityControl, ForumMessageListInputHiddenControl, ForumMessageListPaginationControl, FriendlyIdValidationControl, GenerateContentButtonControl, GenericAclControl, GroupAclControl, HierarchicalContentHtmlTextAreaControl, HierarchicalTabularDataControl, HtmlEditorControl, HtmlEditorValidatorControl, IncludeControl, InputCategoryControl, InputEmailControl, InputHiddenControl, InputProfileImageControl, InputTagControl, InputTextAreaControl, InputTextControl, InputTextProxyControl, IntegerDataTypeValidatorControl, InterfaceHeaderButtonsControl, InterfaceHeaderControl, InterfaceInstanceInContextEditSupportControl, InterfaceInstancePreviewControl, InterfaceSelectionDropDownListControl, ItemPickerControl, LabelControl, LanguageControl, LanguageFilterControl, LastContentsAdvancedTabularDataControl, LastWeekDateTimePickerControl, LazySourceDropDownListControl, LengthValidatorControl, LicenseTypeInputHiddenControl, LinkControl, LinkTabularDataControl, LinkToRuntimeTabularDataControl, LinkToRuntimeTabularDataControl, ListControl, LoadTransformationFromDataBaseControl, LocalePickerControl, LockButtonControl, LockedMessageControl, LogoutOriginalWebResourcePathInputHiddenControl, MediaParentFilterControl, MediaPickerControl, MobileAppInputFileControl, MonthPickerControl, MultiFileUploadControl, MultiFileUploadExtensionCheckControl, MultiFileUploadRequiredValueValidatorControl, MultiItemPickerControl, NavigationControl, NavigationHtmlTextAreaControl, NumberDataTypeValidatorControl, OkButtonControl, OptionListControl, OrderedMultiItemPickerControl, PageAclControl, PageCacheConfirmMessageControl, PagePersonalizationWidgetUsedByControl, PageTemplateAclControl, PaginationControl, PaneControl, ParentFilterControl, PasswordControl, PortalAclControl, PositionFieldInterfaceHeaderControl, PositionFieldOrderButtonControl, PreviewButtonControl, PrimaryKeyControl, PrincipalPickerControl, PrintButtonControl, ProducerAdministrationListAddButtonControl, ProducerAdminListTabularDataControl, ProducerConfigurationInterfaceVersionDropDownListControl, ProgressControl, ProgressPanelControl, PropertyPageControl, PublisherFiltersAutoLayoutFieldsControl, PublishToPrincipalsControl, PublishToPrincipalsListControl, PublishToServiceInstancesControl, PublishToServiceInstancesListControl, PublishToSocialNetworkButtonControl, PublishToSocialNetworkControl, RadioButtonControl, RadioButtonListControl, RefreshButtonControl, RegularExpressionValidatorControl, RemotePortletConfigurationInterfaceControl, RenderActionOnLoadScriptControl, RequiredValuesDescriptorControl, RequiredValueValidatorControl, RequiredValueWhenEnableControl, RequiredValueWhenVisibleValidatorControl, RestShortNameValidationControl, SaveAndPreviewButtonControl, ScheduleDateTimePickerControl, ScheduleStartDateTimePickerControl, ScriptControl, SearchAggregationControl, SearchOrderByDropDownListControl, SearchQueryInputText, SearchQueryValidatorControl, SearchScopeStandardLabel, SelectAccountServiceInstanceAdvancedTabularDataControl, SelectChannelChildControl, SelectChannelControl, SelectChannelControl, SelectChannelOrChannelTemplateControl, SelectChannelOrChannelTemplateControlWithCustomCallbackFunction, SelectChannelPageTreeControl, SelectChannelPageTreeControl, SelectChannelTemplateControl, SelectContentParentContentControl, SelectDocumentServiceInstanceControl, SelectEmailTemplateServiceInstanceControl, SelectImportFileControl, SelectItemTabularDataControl, SelectMediaServiceInstanceControl, SelectPageControl, SelectPageControl, SelectPageOrPageTemplateControl, SelectPagePersonalizationServiceInstanceControl, SelectPageTemplateControl, SelectParentContentControl, SelectParentContentTreeControl, SelectServiceInstanceControl, SelectTagServiceInstanceControl, SelectWebsiteChannelControl, SelectWorkflowControl, ServiceAclControl, ServiceInstanceAclControl, ServiceInstanceAnalyticsButtonControl, ServiceInstancePrincipalPickerControl, ServiceInstanceUsedByControl, ServiceInterfacePickerControl, ServiceReindexProgressControl, SetWebsiteNameFromChannelControl, ShowAnswersAutoLayoutFieldsControl, ShowAnswersAutoLayoutFieldsControl, SourceBoundControl, SourceFieldBoundControl, StealLockButtonControl, StringsControl, TabbedControl, TabularDataControl, TagControl, TermDynamicListControl, TermPickerControl, TextControl, TimePickerControl, TopicViewCounterControl, UserEmailVerifierControl, UserEmailVerifierControl, UserSegmentationControl, ValidatorButton, ValidatorControl, VersionControl, VersionEditButtonControl, VersionNumberInputHiddenControl, VersionsButtonControl, WebFileReplicationPropertiesControl, WebsiteChangeCheckControl, WikiViewArticlePaneControl, WorkflowActionControl, WorkflowActionControl, WorkflowAssignedToControl, WorkflowAssignedToControl, WorkflowAssignedToFilterControl, WorkflowMetaDataControl, WorkflowMetaDataControl, WorkflowSendToControl, WorkflowSendToControl, WorkflowServiceInstanceAclControl, WorkflowStateControl, WorkflowStateControl, WorkflowStateFilterControl, WorkflowStatusAdvancedTabularDataControl, WSRPCheckBoxListControl, XslEditorControl, XslFileEditorControl

@StableMinor(version="12.4",
             sinceVersion="4.0")
public interface IControl

Interface that must be implemented by all controls

Since:

4.0.0

Version:

$Revision: 23905 $ $Date: 2020-06-16 15:29:26 +0000 (Tue, 16 Jun 2020) $

Method Summary

Modifier and Type	Method and Description
void	buildSubControls()
void	createContainer(String containerId) Creates a container for the control.
void	disconnect()
List<IControl>	getChildControls()
IResource	getControlResource()
String	getId()
String	getName() Returns the name for this control.
IControl	getParentControl()
String	getPrepareForReadScript()
String	getRenderData() Returns an xml string representation of the control for rendering via xsl.
List<IResource>	getResources()
String	getType()
void	init(Node controlDefinitionNode, ControlContainer controlContainer, IControl parentControl)
boolean	isValid()
void	registerOnEventScript(String onEvent, String script)
void	removeChild(IControl childControl)
void	removeChildren()
void	setRenderData()
void	setRuntimeAttributes() Replaces runtime attributes in this control's definition node with their evaluated values.
void	setValid(boolean isValid)

Method Detail

init

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

Throws:

PortalException

buildSubControls

void buildSubControls()
               throws PortalException

Throws:

PortalException

getId

String getId()

getType

String getType()

getName

String getName()

Returns the name for this control. This is usually a friendly name suitable for final user. For example, in input controls it is usually the label of the field being edited.

Returns:

the name. null may be returned if the control has no name.

Since:

7.1.0

getChildControls

List<IControl> getChildControls()
                         throws PortalException

Throws:

PortalException

setRenderData

void setRenderData()
            throws PortalException

Throws:

PortalException

getParentControl

IControl getParentControl()

getControlResource

IResource getControlResource()
                      throws PortalException

Throws:

PortalException

registerOnEventScript

void registerOnEventScript(String onEvent,
                           String script)
                    throws PortalException

Throws:

PortalException

isValid

boolean isValid()
         throws PortalException

Throws:

PortalException

setValid

void setValid(boolean isValid)
       throws PortalException

Throws:

PortalException

getResources

List<IResource> getResources()
                      throws PortalException

Throws:

PortalException

disconnect

void disconnect()
         throws PortalException

Throws:

PortalException

removeChild

void removeChild(IControl childControl)
          throws PortalException

Throws:

PortalException

removeChildren

void removeChildren()
             throws PortalException

Throws:

PortalException

getPrepareForReadScript

String getPrepareForReadScript()
                        throws PortalException

Throws:

PortalException

createContainer

void createContainer(String containerId)
              throws PortalException

Creates a container for the control.

This method us used by the framework when a control needs to be updated client side.

Parameters:

containerId -

Throws:

PortalException

Since:

4.0.11

getRenderData

String getRenderData()
              throws PortalException

Returns an xml string representation of the control for rendering via xsl.

Returns:

Throws:

PortalException

Since:

4.0.11

setRuntimeAttributes

void setRuntimeAttributes()

Replaces runtime attributes in this control's definition node with their evaluated values. A runtime attribute follows the EL syntax.

This method is executed before setRenderData() by the ControlContainer.

Since:

4.0.3

See Also:

ControlContainer