Package de.hybris.platform.cockpit.wizards.generic

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:

ConstraintsMandatoryPage

public class GenericItemMandatoryPage
extends AbstractGenericItemPage

Represents page that displays all necessary editors for required properties in order to create an instance of specified 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:

GenericItemWizard, WizardConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	WIZARD_CONFIG
protected static java.lang.String	WIZARD_GROUP_CONTAINER
protected static java.lang.String	WIZARD_GROUP_EDITOR_CONTAINER
protected static java.lang.String	WIZARD_GROUP_LABEL
protected static java.lang.String	WIZARD_GROUP_ROW_LABEL
protected static java.lang.String	WIZARD_SECTION

Fields 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_SCLASS

Fields inherited from class de.hybris.platform.cockpit.wizards.impl.DefaultPage

height, title, width, wizard

Constructor Summary

Constructors

Constructor	Description
GenericItemMandatoryPage()
GenericItemMandatoryPage(java.lang.String pageTitle)
GenericItemMandatoryPage(java.lang.String pageTitle, GenericItemWizard wizard)

Method Summary

Modifier and Type	Method	Description
protected AdvancedGroupbox	createGroup(org.zkoss.zk.ui.HtmlBasedComponent parent, boolean open, java.lang.String label)	Creates one single group for particular page
protected org.zkoss.zk.ui.Component	createGroupRow(org.zkoss.zk.ui.Component parent, PropertyDescriptor descriptor, TypedObject currentObject, java.lang.String editorCode, int errorLevel, java.util.Map<java.lang.String,java.lang.String> params)	Creates one single row for group on that page.
protected void	createGroupSectionContent(org.zkoss.zk.ui.HtmlBasedComponent group, java.util.Collection<java.lang.String> allreadyDisplayedProperties, java.util.Collection<java.lang.String> displaydDescriptors, WizardConfiguration wizardConfiguration)	Creates a group content accordingly to given parameters
org.zkoss.zk.ui.Component	createRepresentationItself()	This is an general method responsible for creating UI representation of given page
protected java.util.List<java.lang.String>	extractPropertyQualifiers(java.util.List<PropertyDescriptor> propertyDescriptors)
WizardPageController	getController()
DefaultGenericItemMandatoryPageController	getDefaultController()
java.util.List<java.lang.String>	getDisplayedAttributes()
java.util.Map<java.lang.String,? extends java.lang.Object>	getParameters()
protected UIConfigurationService	getUIConfigurationService()
java.lang.Object	getValue()
protected WizardConfiguration	getWizardConfiguration()
protected void	loadInitConfigValues(PropertyDescriptor descriptor, WizardConfiguration wizardConfig)	Method loads initial values that can be defined within WizardConfiguration
protected void	render(org.zkoss.zk.ui.HtmlBasedComponent parent, java.util.Collection<java.lang.String> requiredDescriptors)	Main method that is used for render whole page's content (i.e.
void	setDefaultController(DefaultGenericItemMandatoryPageController defaultController)
void	setParameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters)
void	setValue(java.lang.Object value)

Methods inherited from class de.hybris.platform.cockpit.wizards.generic.AbstractGenericItemPage

clearPageComponents, getErrorContainer, getNextPageWizardId, getPageContainer, getPageContent, getWizard, handleMessages, isCauseError, setDisplayedAttributes, setNextPageWizardId

Methods 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

Methods inherited from class java.lang.Object

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

Field Detail

WIZARD_CONFIG

protected static final java.lang.String WIZARD_CONFIG

See Also:

Constant Field Values

WIZARD_GROUP_LABEL

protected static final java.lang.String WIZARD_GROUP_LABEL

See Also:

Constant Field Values

WIZARD_GROUP_CONTAINER

protected static final java.lang.String WIZARD_GROUP_CONTAINER

See Also:

Constant Field Values

WIZARD_GROUP_EDITOR_CONTAINER

protected static final java.lang.String WIZARD_GROUP_EDITOR_CONTAINER

See Also:

Constant Field Values

WIZARD_GROUP_ROW_LABEL

protected static final java.lang.String WIZARD_GROUP_ROW_LABEL

See Also:

Constant Field Values

WIZARD_SECTION

protected static final java.lang.String WIZARD_SECTION

See Also:

Constant Field Values

Constructor Detail

GenericItemMandatoryPage

public GenericItemMandatoryPage()

GenericItemMandatoryPage

public GenericItemMandatoryPage(java.lang.String pageTitle)

GenericItemMandatoryPage

public GenericItemMandatoryPage(java.lang.String pageTitle,
                                GenericItemWizard wizard)

Method Detail

getDefaultController

public DefaultGenericItemMandatoryPageController getDefaultController()

setDefaultController

public void setDefaultController(DefaultGenericItemMandatoryPageController defaultController)

getController

public WizardPageController getController()

Specified by:

getController in interface WizardPage

Overrides:

getController in class DefaultPage

createGroupRow

protected final org.zkoss.zk.ui.Component createGroupRow(org.zkoss.zk.ui.Component parent,
                                                         PropertyDescriptor descriptor,
                                                         TypedObject currentObject,
                                                         java.lang.String editorCode,
                                                         int errorLevel,
                                                         java.util.Map<java.lang.String,java.lang.String> params)

Creates one single row for group on that page.

Parameters:

parent - parent component HtmlBasedComponent

descriptor - property descriptor for which editor should be displayed

currentObject - current object TypedObject

editorCode - editor code that should be used for displaying given properties

errorLevel - is this property causing error

params - configuration parameters

Returns:

a component that represents row within group

createGroupSectionContent

protected void createGroupSectionContent(org.zkoss.zk.ui.HtmlBasedComponent group,
                                         java.util.Collection<java.lang.String> allreadyDisplayedProperties,
                                         java.util.Collection<java.lang.String> displaydDescriptors,
                                         WizardConfiguration wizardConfiguration)

Creates a group content accordingly to given parameters

Parameters:

group - parent @{link HtmlBasedComponent

allreadyDisplayedProperties - properties already displayed

displaydDescriptors - properties that should be displayed for that group

wizardConfiguration - wizard configuration

createRepresentationItself

public org.zkoss.zk.ui.Component createRepresentationItself()

Description copied from class: AbstractGenericItemPage

This is an general method responsible for creating UI representation of given page

Note:
Here we should create graphical representation of particular page

Specified by:

createRepresentationItself in interface GenericItemWizardPage

Specified by:

createRepresentationItself in class AbstractGenericItemPage

createGroup

protected AdvancedGroupbox createGroup(org.zkoss.zk.ui.HtmlBasedComponent parent,
                                       boolean open,
                                       java.lang.String label)

Creates one single group for particular page

Parameters:

parent - component HtmlBasedComponent

open - flag that determines whether groups should be opened

label - group label

Returns:

a component that represents single group

extractPropertyQualifiers

protected java.util.List<java.lang.String> extractPropertyQualifiers(java.util.List<PropertyDescriptor> propertyDescriptors)

getDisplayedAttributes

public java.util.List<java.lang.String> getDisplayedAttributes()

Overrides:

getDisplayedAttributes in class AbstractGenericItemPage

Returns:

the displayedAttributes

getParameters

public java.util.Map<java.lang.String,? extends java.lang.Object> getParameters()

getUIConfigurationService

protected UIConfigurationService getUIConfigurationService()

getValue

public java.lang.Object getValue()

getWizardConfiguration

protected WizardConfiguration getWizardConfiguration()

loadInitConfigValues

protected void loadInitConfigValues(PropertyDescriptor descriptor,
                                    WizardConfiguration wizardConfig)

Method loads initial values that can be defined within WizardConfiguration

Parameters:

descriptor - property descriptor

wizardConfig - current wizard configuration

render

protected void render(org.zkoss.zk.ui.HtmlBasedComponent parent,
                      java.util.Collection<java.lang.String> requiredDescriptors)

Main method that is used for render whole page's content (i.e. all group and rows configured via WizardConfiguration)

Parameters:

parent - component HtmlBasedComponent

requiredDescriptors - descriptors that are required in order to instantiate a given @{link ObjectTemplate

setParameters

public void setParameters(java.util.Map<java.lang.String,? extends java.lang.Object> parameters)

setValue

public void setValue(java.lang.Object value)