de.hybris.platform.cscockpit.wizards.generic

Class NewItemsWizardPage

java.lang.Object

de.hybris.platform.cockpit.wizards.impl.DefaultPage

de.hybris.platform.cscockpit.wizards.generic.AbstractNewItemWizardPage

de.hybris.platform.cscockpit.wizards.generic.NewItemsWizardPage

All Implemented Interfaces:

WizardPage

Direct Known Subclasses:

CustomerEmailWizardPage, NewTicketAssignAgentPage, TicketWizardPage

public class NewItemsWizardPage
extends AbstractNewItemWizardPage

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	WIZARD_GROUP_CONTAINER
protected static String	WIZARD_GROUP_EDITOR_CONTAINER
protected static String	WIZARD_GROUP_ROW_LABEL

Fields inherited from class de.hybris.platform.cscockpit.wizards.generic.AbstractNewItemWizardPage

ERROR_SCLASS_ELEMENT_BOX_EDITOR, ERROR_SCLASS_WIZARD_CNT, errorContainer, pageContainer, pageContent, SCLASS_ELEMENT_BOX_EDITOR, 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 and Description
NewItemsWizardPage()

Method Summary

Modifier and Type	Method and Description
Component	createContent(WizardPage page, WizardPageController controller) This is an general method responsible for creating UI representation of given page Note: Here we should create graphical representation of particular page
protected Component	createGroupRow(Component parent, PropertyDescriptor descriptor, String editorCode, boolean error, Map<String,Object> params) Creates one single row for group on that page.
protected void	createGroupSectionContent(HtmlBasedComponent group, Collection<String> alreadyDisplayedProperties, Collection<String> displayedDescriptors, WizardConfiguration wizardConfiguration) Creates a group content accordingly to given parameters
protected List<String>	extractPropertyQualifiers(List<PropertyDescriptor> propertyDescriptors)
WizardPageController	getController()
protected String	getDescriptorLabel(PropertyDescriptor descriptor, Map<String,Object> params)
List<String>	getDisplayedAttributes()
List<PropertyDescriptor>	getRequiredPropertyDescriptors()
protected UIConfigurationService	getUIConfigurationService()
AbstractNewItemsWizard	getWizard()
protected WizardConfiguration	getWizardConfiguration()
protected String	getWizardConfigurationCode()
protected String	getWizardConfigurationType()
boolean	isDisableAutoPersist()
protected boolean	isRequiredProperty(PropertyDescriptor descriptor, WizardConfiguration wizardConfig)
protected void	loadInitConfigValues(PropertyDescriptor descriptor, WizardConfiguration wizardConfig) Method loads initial values that can be defined within WizardConfiguration
protected void	render(HtmlBasedComponent parent) Main method that is used for render whole page's content (i.e.
void	setDisableAutoPersist(boolean disableAutoPersist)
void	setWizardConfigurationCode(String wizardConfigurationCode)
void	setWizardConfigurationType(String wizardConfigurationType)

Methods inherited from class de.hybris.platform.cscockpit.wizards.generic.AbstractNewItemWizardPage

clearPageComponents, getCockpitTypeService, getErrorContainer, getModelService, getNextPageWizardId, getPageContainer, getPageContent, getSystemService, handleMessages, isCauseError, setCockpitTypeService, setDisplayedAttributes, setModelService, setNextPageWizardId, setSystemService

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_GROUP_CONTAINER

protected static final String WIZARD_GROUP_CONTAINER

See Also:

Constant Field Values

WIZARD_GROUP_EDITOR_CONTAINER

protected static final String WIZARD_GROUP_EDITOR_CONTAINER

See Also:

Constant Field Values

WIZARD_GROUP_ROW_LABEL

protected static final String WIZARD_GROUP_ROW_LABEL

See Also:

Constant Field Values

Constructor Detail

NewItemsWizardPage

public NewItemsWizardPage()

Method Detail

getWizardConfigurationType

protected String getWizardConfigurationType()

setWizardConfigurationType

public void setWizardConfigurationType(String wizardConfigurationType)

getWizardConfigurationCode

protected String getWizardConfigurationCode()

setWizardConfigurationCode

public void setWizardConfigurationCode(String wizardConfigurationCode)

isDisableAutoPersist

public boolean isDisableAutoPersist()

Returns:

the disableAutoPersist

setDisableAutoPersist

public void setDisableAutoPersist(boolean disableAutoPersist)

getWizard

public AbstractNewItemsWizard getWizard()

Overrides:

getWizard in class DefaultPage

getController

public WizardPageController getController()

Specified by:

getController in interface WizardPage

Overrides:

getController in class DefaultPage

createContent

public Component createContent(WizardPage page,
                               WizardPageController controller)

Description copied from class: AbstractNewItemWizardPage

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:

createContent in class AbstractNewItemWizardPage

render

protected void render(HtmlBasedComponent parent)

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

Parameters:

parent - component org.zkoss.zk.ui.HtmlBasedComponent

createGroupSectionContent

protected void createGroupSectionContent(HtmlBasedComponent group,
                                         Collection<String> alreadyDisplayedProperties,
                                         Collection<String> displayedDescriptors,
                                         WizardConfiguration wizardConfiguration)

Creates a group content accordingly to given parameters

Parameters:

group - parent @{link org.zkoss.zk.ui.HtmlBasedComponent

alreadyDisplayedProperties - properties already displayed

displayedDescriptors - properties that should be displayed for that group

wizardConfiguration - wizard configuration

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

createGroupRow

protected Component createGroupRow(Component parent,
                                   PropertyDescriptor descriptor,
                                   String editorCode,
                                   boolean error,
                                   Map<String,Object> params)

Creates one single row for group on that page.

Parameters:

parent - parent component org.zkoss.zk.ui.HtmlBasedComponent

descriptor - property descriptor for which editor should be displayed

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

error - is this property causing error

params - configuration parameters

Returns:

a component that represents row within group

getDescriptorLabel

protected String getDescriptorLabel(PropertyDescriptor descriptor,
                                    Map<String,Object> params)

extractPropertyQualifiers

protected List<String> extractPropertyQualifiers(List<PropertyDescriptor> propertyDescriptors)

getDisplayedAttributes

public List<String> getDisplayedAttributes()

Overrides:

getDisplayedAttributes in class AbstractNewItemWizardPage

Returns:

the displayedAttributes

getUIConfigurationService

protected UIConfigurationService getUIConfigurationService()

getWizardConfiguration

protected WizardConfiguration getWizardConfiguration()

getRequiredPropertyDescriptors

public List<PropertyDescriptor> getRequiredPropertyDescriptors()

isRequiredProperty

protected boolean isRequiredProperty(PropertyDescriptor descriptor,
                                     WizardConfiguration wizardConfig)