lumis.doui.control
Interface IControl

Package class diagram package IControl
All Known Subinterfaces:
IDataBoundControl, IDataControl, IErrorSummaryControl, IValidatorControl
All Known Implementing Classes:
AccessControlButton, AccessErrorMessageTranslator, AddButtonControl, AddDynamicListSourceControl, AdministrationListControl, AdvancedTabularDataControl, AnnouncementTabularDataControl, AsyncProgressControl, AutoAdministrationListButtonsControl, AutoContentAdministrationListButtonsControl, AutoEmbeddedInterfaceStandardButtonsControl, AutoInterfaceStandardButtonsControl, AutoLayoutAdministrationListControl, AutoLayoutAssociationInformationControl, AutoLayoutContentAdministrationListControl, AutoLayoutContentDetailsControl, AutoLayoutContentEmbeddedPropertyPageControl, AutoLayoutContentFieldsControl, AutoLayoutContentListControl, AutoLayoutContentPropertyPageControl, AutoLayoutContentQuickListControl, AutoLayoutDetailsControl, AutoLayoutEmbeddedPropertyPageControl, AutoLayoutFieldControl, AutoLayoutFieldsControl, AutoLayoutLanguageInformationControl, AutoLayoutListControl, AutoLayoutMetaDataInformationControl, AutoLayoutPropertyPageControl, AutoLayoutPublishingInformationControl, AutoLayoutQuickListControl, AutoLayoutWorkflowInformationControl, AutoPopupInterfaceStandardButtonsControl, AutoRefreshControl, BannerControl, BaseParametersControl, ButtonControl, CalendarControl, CancelButtonControl, ChannelAclControl, ChannelInheritedPageTemplateControl, ChatHistoryControl, ChatMessageListControl, ChatSendMessageControl, CheckBoxControl, CheckBoxListControl, CommentsAddControl, CommentsControl, ConfigParametersControl, ConfigureButtonControl, ContentPickerControl, Control, ControlGroupControl, CurrentItemIdControl, DataBoundControl, DataControl, DataGridControl, DateCompareValidatorControl, DateDataTypeValidatorControl, DateTimePickerControl, DeleteButtonControl, DetailsControl, DocumentPickerControl, DropDownListControl, DynamicListControl, EditButtonControl, EmailValidatorControl, ErrorSummaryControl, FieldsControl, FileListControl, FileNameValidatorControl, FileSizeValidatorControl, FilesPickerControl, FileSystemTabularData, FileUploadControl, FilterControl, FiltersControl, FilterUniqueIdValidator, FormControl, ForumButtonVisibilityControl, GenericAclControl, GroupAclControl, HtmlEditorControl, HtmlEditorValidatorControl, ImagePickerControl, InputHiddenControl, InputTextAreaControl, InputTextControl, InputTextProxyControl, IntegerDataTypeValidatorControl, InterfaceHeaderControl, ItemPickerControl, LabelControl, LanguageAssociatedContentsControl, LanguageControl, LengthValidatorControl, LinkControl, LinkTabularDataControl, ListControl, LocalePickerControl, MonthPickerControl, MultiItemPickerControl, NavigationControl, NumberDataTypeValidatorControl, OkButtonControl, OptionListControl, PageAclControl, PageTemplateAclControl, PaginationControl, PaneControl, ParentFilterControl, PasswordControl, PortalAclControl, PreviewButtonControl, PrimaryKeyControl, PrincipalPickerControl, PrintButtonControl, ProgressControl, ProgressPanelControl, PropertyPageControl, PublishToPrincipalsControl, PublishToPrincipalsListControl, PublishToServiceInstancesControl, PublishToServiceInstancesListControl, RadioButtonControl, RefreshButtonControl, RegularExpressionValidatorControl, RequiredValuesDescriptorControl, RequiredValueValidatorControl, RequiredValueWhenVisibleValidatorControl, RuntimeParametersControl, SaveAndPreviewButtonControl, ScheduleDateTimePickerControl, ScriptControl, SearchQueryValidatorControl, SelectChannelChildControl, SelectChannelControl, SelectChannelOrChannelTemplateControl, SelectChannelPageTreeControl, SelectChannelTemplateControl, SelectDocumentServiceInstanceControl, SelectImageServiceInstanceControl, SelectImportFileControl, SelectItemTabularDataControl, SelectPageControl, SelectPageOrPageTemplateControl, SelectPageTemplateControl, SelectParentContentControl, SelectParentContentTreeControl, SelectServiceInstanceControl, SelectWorkflowControl, ServiceAclControl, ServiceInstanceAclControl, ServiceInstancePrincipalPickerControl, ServiceInstanceUsedByControl, ServiceSearchIndexProgressPanelControl, StringsControl, TabbedControl, TabularDataControl, TermPickerControl, TextControl, TimePickerControl, TopicViewCounterControl, UserEmailVerifierControl, UserEmailVerifierControl, ValidatorControl, VersionControl, VersionEditButtonControl, VersionsButtonControl, WorkflowActionControl, WorkflowAssignedToControl, WorkflowMetaDataControl, WorkflowSendToControl, WorkflowServiceInstanceAclControl, WorkflowStateControl, XslFileEditorControl

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

Interface that must be implemented by all controls

Since:
4.0.0

Method Summary
 void buildSubControls()
           
 void createContainer(String containerId)
          Creates a container for the control.
 void disconnect()
           
 List<IControl> getChildControls()
           
 IResource getControlResource()
           
 String getId()
           
 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()

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


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.