Class GenericItemMandatoryPage
java.lang.Object
de.hybris.platform.cockpit.wizards.impl.DefaultPage
de.hybris.platform.cockpit.wizards.generic.AbstractGenericItemPage
de.hybris.platform.cockpit.wizards.generic.GenericItemMandatoryPage
- All Implemented Interfaces:
GenericItemWizardPage,WizardPage
- Direct Known Subclasses:
CmsSiteSummaryPage,ConstraintsMandatoryPage
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 StringFields inherited from class de.hybris.platform.cockpit.wizards.generic.AbstractGenericItemPage
CONTENT_ELEMENT_CONFIG, ERROR_SCLASS_ELEMENT_BOX_EDITOR, ERROR_SCLASS_WIZARD_CNT, errorContainer, INFO_SCLASS_ELEMENT_BOX_EDITOR, INFO_SCLASS_WIZARD_CNT, pageContainer, pageContent, SCLASS_ELEMENT_BOX_EDITOR, WARNING_SCLASS_ELEMENT_BOX_EDITOR, WARNING_SCLASS_WIZARD_CNT, WIZARD_ERROR_CNT_SCLASS, WIZARD_PAGE_CNT_SCLASS, WIZARD_PAGE_CONTENT_CNT_SCLASSFields inherited from class de.hybris.platform.cockpit.wizards.impl.DefaultPage
height, title, width, wizard -
Constructor Summary
ConstructorsConstructorDescriptionGenericItemMandatoryPage(String pageTitle) GenericItemMandatoryPage(String pageTitle, GenericItemWizard wizard) -
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, int errorLevel, 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.ComponentThis is an general method responsible for creating UI representation of given pageextractPropertyQualifiers(List<PropertyDescriptor> propertyDescriptors) protected UIConfigurationServicegetValue()protected WizardConfigurationprotected voidloadInitConfigValues(PropertyDescriptor descriptor, WizardConfiguration wizardConfig) Method loads initial values that can be defined withinWizardConfigurationprotected voidrender(org.zkoss.zk.ui.HtmlBasedComponent parent, Collection<String> requiredDescriptors) Main method that is used for render whole page's content (i.e.voidsetDefaultController(DefaultGenericItemMandatoryPageController defaultController) voidsetParameters(Map<String, ? extends Object> parameters) voidMethods inherited from class de.hybris.platform.cockpit.wizards.generic.AbstractGenericItemPage
clearPageComponents, getErrorContainer, getNextPageWizardId, getPageContainer, getPageContent, getWizard, handleMessages, isCauseError, setDisplayedAttributes, setNextPageWizardIdMethods inherited from class de.hybris.platform.cockpit.wizards.impl.DefaultPage
getAttributes, getComponentURI, getCurrentController, getHeight, getId, getPageComponent, getTitle, getWidth, initView, renderView, setComponentURI, setController, setId, setPageComponent, setTitle, setWizard
-
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:
-
-
Constructor Details
-
GenericItemMandatoryPage
public GenericItemMandatoryPage() -
GenericItemMandatoryPage
-
GenericItemMandatoryPage
-
-
Method Details
-
getDefaultController
-
setDefaultController
-
getController
- Specified by:
getControllerin interfaceWizardPage- Overrides:
getControllerin classDefaultPage
-
createGroupRow
protected final org.zkoss.zk.ui.Component createGroupRow(org.zkoss.zk.ui.Component parent, PropertyDescriptor descriptor, TypedObject currentObject, String editorCode, int errorLevel, 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 propertieserrorLevel- 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()Description copied from class:AbstractGenericItemPageThis is an general method responsible for creating UI representation of given page Note:
Here we should create graphical representation of particular page- Specified by:
createRepresentationItselfin interfaceGenericItemWizardPage- Specified by:
createRepresentationItselfin classAbstractGenericItemPage
-
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
-
extractPropertyQualifiers
-
getDisplayedAttributes
- Overrides:
getDisplayedAttributesin classAbstractGenericItemPage- 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
-
setParameters
-
setValue
-