Class MandatoryPage
java.lang.Object
de.hybris.platform.cockpit.wizards.impl.DefaultPage
de.hybris.platform.cmscockpit.wizard.page.AbstractCmsWizardPage
de.hybris.platform.cmscockpit.wizard.page.MandatoryPage
- All Implemented Interfaces:
CmsWizardPage,WizardPage
- Direct Known Subclasses:
CreatePageMandatoryPage
Represents page that displays all necessary editors for required properties in order to create an instance of
specified
User can configure properties that should be presented on that page by using wizard configuration
ObjectTemplate. This is used by cockpit wizards GenericItemWizard
Note: User can configure properties that should be presented on that page by using wizard configuration
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final StringFields inherited from class de.hybris.platform.cmscockpit.wizard.page.AbstractCmsWizardPage
CMSWIZARD_ERROR_CNT_SCLASS, CMSWIZARD_PAGE_CNT_SCLASS, CMSWIZARD_PAGE_CONTENT_CNT_SCLASS, CONTENT_ELEMENT_CONFIG, ERROR_SCLASS_CMSWIZARD_CNT, ERROR_SCLASS_ELEMENT_BOX_EDITOR, errorContainer, pageContainer, pageContent, SCLASS_ELEMENT_BOX_EDITORFields inherited from class de.hybris.platform.cockpit.wizards.impl.DefaultPage
height, title, width, wizard -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected AdvancedGroupboxcreateGroup(org.zkoss.zk.ui.HtmlBasedComponent parent, boolean open, String label) Creates one single group for particular pageprotected final org.zkoss.zk.ui.ComponentcreateGroupRow(org.zkoss.zk.ui.Component parent, PropertyDescriptor descriptor, TypedObject currentObject, String editorCode, boolean error, Map<String, String> params) Creates one single row for group on that page.protected voidcreateGroupSectionContent(org.zkoss.zk.ui.HtmlBasedComponent group, Collection<String> allreadyDisplayedProperties, Collection<String> displaydDescriptors, WizardConfiguration wizardConfiguration) Creates a group content accordingly to given parametersorg.zkoss.zk.ui.ComponentextractPropertyQualifiers(List<PropertyDescriptor> propertyDescriptors) protected UIConfigurationServicegetValue()protected WizardConfigurationbooleanprotected voidloadInitConfigValues(PropertyDescriptor descriptor, WizardConfiguration wizardConfig) Method loads initial values that can be defined withinWizardConfigurationprotected org.zkoss.zul.Radiogroupprotected voidrender(org.zkoss.zk.ui.HtmlBasedComponent parent, Collection<String> requiredDescriptors) Main method that is used for render whole page's content (i.e.voidsetParameters(Map<String, ? extends Object> parameters) voidMethods inherited from class de.hybris.platform.cmscockpit.wizard.page.AbstractCmsWizardPage
clearPageComponents, getErrorContainer, getPageContainer, getPageContent, getWizard, handleMessages, isCauseError, setDisplayedAttributesMethods inherited from class de.hybris.platform.cockpit.wizards.impl.DefaultPage
getAttributes, getComponentURI, getController, getCurrentController, getHeight, getId, getPageComponent, getTitle, getWidth, initView, renderView, setComponentURI, setController, setId, setPageComponent, setTitle, setWizardMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface de.hybris.platform.cockpit.wizards.WizardPage
getAttributes, getComponentURI, getController, getHeight, getId, getTitle, getWidth, initView
-
Field Details
-
WIZARD_CONFIG
- See Also:
-
WIZARD_GROUP_LABEL
- See Also:
-
WIZARD_GROUP_CONTAINER
- See Also:
-
WIZARD_GROUP_EDITOR_CONTAINER
- See Also:
-
WIZARD_GROUP_ROW_LABEL
- See Also:
-
WIZARD_SECTION
- See Also:
-
COCKPIT_ID_CREATE_PAGE_PREFIX
- See Also:
-
-
Constructor Details
-
MandatoryPage
-
-
Method Details
-
createGroupRow
protected final org.zkoss.zk.ui.Component createGroupRow(org.zkoss.zk.ui.Component parent, PropertyDescriptor descriptor, TypedObject currentObject, String editorCode, boolean error, Map<String, String> params) Creates one single row for group on that page.- Parameters:
parent- parent componentHtmlBasedComponentdescriptor- property descriptor for which editor should be displayedcurrentObject- current objectTypedObjecteditorCode- editor code that should be used for displaying given propertieserror- is this property causing errorparams- configuration parameters- Returns:
- a component that represents row within group
-
createGroupSectionContent
protected void createGroupSectionContent(org.zkoss.zk.ui.HtmlBasedComponent group, Collection<String> allreadyDisplayedProperties, Collection<String> displaydDescriptors, WizardConfiguration wizardConfiguration) Creates a group content accordingly to given parameters- Parameters:
group- parent @{linkHtmlBasedComponentallreadyDisplayedProperties- properties already displayeddisplaydDescriptors- properties that should be displayed for that groupwizardConfiguration- wizard configuration
-
createRepresentationItself
public org.zkoss.zk.ui.Component createRepresentationItself()- Specified by:
createRepresentationItselfin interfaceCmsWizardPage- Specified by:
createRepresentationItselfin classAbstractCmsWizardPage
-
createGroup
protected AdvancedGroupbox createGroup(org.zkoss.zk.ui.HtmlBasedComponent parent, boolean open, String label) Creates one single group for particular page- Parameters:
parent- componentHtmlBasedComponentopen- flag that determines whether groups should be openedlabel- group label- Returns:
- a component that represents single group
-
positioningOptions
protected org.zkoss.zul.Radiogroup positioningOptions() -
extractPropertyQualifiers
-
getDisplayedAttributes
- Overrides:
getDisplayedAttributesin classAbstractCmsWizardPage- Returns:
- the displayedAttributes
-
getParameters
-
getUIConfigurationService
-
getValue
-
getWizardConfiguration
-
loadInitConfigValues
protected void loadInitConfigValues(PropertyDescriptor descriptor, WizardConfiguration wizardConfig) Method loads initial values that can be defined withinWizardConfiguration- Parameters:
descriptor- property descriptorwizardConfig- current wizard configuration
-
render
protected void render(org.zkoss.zk.ui.HtmlBasedComponent parent, Collection<String> requiredDescriptors) Main method that is used for render whole page's content (i.e. all group and rows configured viaWizardConfiguration)- Parameters:
parent- componentHtmlBasedComponentrequiredDescriptors- descriptors that are required in order to instantiate a given @{linkObjectTemplate
-
isAddSelectedElementsAtTop
public boolean isAddSelectedElementsAtTop() -
setParameters
-
setValue
-