SectionPanel (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- HtmlMacroComponent
- - de.hybris.platform.cockpit.components.sectionpanel.SectionPanel

All Implemented Interfaces:: DesktopRemovalAwareComponent

public final class SectionPanel
extends HtmlMacroComponent
implements DesktopRemovalAwareComponent

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class SectionPanel.SectionComponent

protected class SectionPanel.SectionRowComponent

Nested Classes
Modifier and Type	Class and Description
`class`	`SectionPanel.SectionComponent`
`protected class`	`SectionPanel.SectionRowComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLASS_SECTION_SELECTED_ROW`
`protected static String`	`EVENT_TAG`
`static String`	`FOCUSABLE_COMPONENT`
`protected static String`	`NAVIGATION_EVENT`
`static String`	`ON_ALL_MESSAGE_SHOW`
`static String`	`ON_ALL_ROWS_SHOW`
`static String`	`ON_ALL_SECTIONS_SHOW`
`static String`	`ON_MESSAGE_CLICKED`
`static String`	`ON_MESSAGE_HIDE`
`static String`	`ON_ROW_HIDE`
`static String`	`ON_ROW_MOVED`
`static String`	`ON_ROW_SHOW`
`static String`	`ON_SECTION_ADDED`
`static String`	`ON_SECTION_CLOSED`
`static String`	`ON_SECTION_HIDE`
`static String`	`ON_SECTION_LABEL_CHANGE`
`static String`	`ON_SECTION_MOVED`
`static String`	`ON_SECTION_OPEN`
`static String`	`ON_SECTION_REMOVED`
`static String`	`ON_SECTION_SHOW`
`static String`	`ON_SECTIONS_COLLAPSED`
`static String`	`ON_SECTIONS_EXPANDED`
`protected static String`	`PERSP_ID`
`protected static String`	`PERSP_TAG` Jumping url stuff for "change constraint" feature
`protected static String`	`PNAV_CONSTRAINT`
`static String`	`SECTION_NAME`
`static String`	`SECTION_ROW`

Constructor Summary

Constructors
Constructor and Description

SectionPanel()

Constructors
Constructor and Description
`SectionPanel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterCompose()`
`protected void`	`appendPanelSpecificMenuItems(Menupopup menuPopUp)`
`protected void`	`appendSectionSpecificMenuItems(Menupopup menuPopUp, Section section)`
`protected void`	`appendViewSettingsMenu(Menupopup menuPopUp)`
`void`	`attacheValidationMenupopup(SectionRow row, Menupopup menuPopup)`
`protected void`	`collapseAllSections(SectionPanel.SectionComponent exclude)`
`HtmlBasedComponent`	`createRowComponent(Section section, SectionRow row, Component rowContainer, Component sectionContentContainer)`
`SectionPanel.SectionRowComponent`	`createRowComponent(Section section, SectionRow row, Component rowContainer, Component sectionContentContainer, String labelWidth)`
`protected Menupopup`	`createRowContextMenu(SectionRow row, Section section)`
`protected Menu`	`createRowsMenu(Section section)`
`protected Div`	`createRowValueContainer(SectionRow row)`
`protected Menupopup`	`createSectionContextMenu(Section section)`
`void`	`desktopRemoved(Desktop desktop)`
`void`	`detach()`
`protected void`	`doRowHidden(SectionRow row)`
`protected void`	`doRowShown(SectionRow row)`
`protected void`	`doRowUpdated(SectionRow row)`
`protected void`	`doSectionAdded(Section section)`
`protected void`	`doSectionHidden(Section section)`
`protected void`	`doSectionRemoved(Section section)`
`protected void`	`doSectionShown(Section section)`
`protected void`	`doSectionUpdated(Section section)`
`protected void`	`expandAllSections()`
`void`	`focusNext(SectionRow row, String nextIso)`
`Set<SectionRow>`	`getAllRows()`
`protected List<SectionPanel.SectionComponent>`	`getAllSectionComponents()`
`protected Menupopup`	`getContextMenu()`
`String`	`getImageUrl()`
`protected Component`	`getInfoContainer()`
`String`	`getLabel()`
`protected Component`	`getLabelContainer()`
`protected Component`	`getMainBorderlayout()`
`MessageBoxRenderer`	`getMessageBoxRenderer()`
`protected Component`	`getMessageContainer()`
`List<Message>`	`getMessages()`
`SectionPanelModel`	`getModel()`
`protected SectionRow`	`getNextVisibleRow(SectionRow row)`
`protected SectionPanel.SectionRowComponent`	`getRowComponent(SectionRow row)`
`String`	`getRowLabelWidth()`
`protected Section`	`getSection(SectionRow row)`
`SectionPanel.SectionComponent`	`getSectionComponent(Section section)`
`protected Component`	`getSectionContainer()`
`protected Component`	`getSectionContainerDiv()`
`SectionPanelLabelRenderer`	`getSectionPanelLabelRenderer()`
`SectionRenderer`	`getSectionRenderer()`
`SectionRowRenderer`	`getSectionRowRenderer()`
`SectionRow`	`getSelectedRow()`
`void`	`handleKeyDown()`
`protected void`	`highlightRow(SectionRow sectionRow)`
`boolean`	`isAlternateOpen()`
`protected boolean`	`isCollectionReference(PropertyDescriptor propertyDescriptor)`
`boolean`	`isEditMode()`
`boolean`	`isFlatSectionLayout()`
`boolean`	`isLazyLoad()`
`boolean`	`isSectionsChangeAllowed()`
`void`	`onCtrlKey(KeyEvent keyEvent)`
`void`	`onDrop(DropEvent event)`
`void`	`onPageDetached(Page page)`
`void`	`onPortalMoved(PortalMoveEvent event)`
`void`	`onShowAllMessages()`
`protected void`	`registerRowComponent(Section section, SectionRow row, SectionPanel.SectionRowComponent comp)`
`protected void`	`registerSectionComponent(Section section, SectionPanel.SectionComponent comp)`
`protected void`	`renderRowValue(Component valueContainer, SectionRow row)`
`protected void`	`renderRowValue(Component valueContainer, SectionRow row, boolean useRowRenderer)`
`protected void`	`resetInfoContainer()`
`protected void`	`resetRowsMenu(SectionPanel panel, Section section, Menupopup nmp)`
`protected void`	`resetSectionMenu(Menu menu)`
`protected void`	`resetView()`
`void`	`setAlternateOpen(boolean alternateOpen)`
`void`	`setEditMode(boolean editMode)`
`void`	`setFlatSectionLayout(boolean flatSectionLayout)`
`void`	`setLazyLoad(boolean lazyLoad)`
`void`	`setMessageBoxRenderer(MessageBoxRenderer messageBoxRenderer)`
`void`	`setModel(SectionPanelModel model)`
`void`	`setRowLabelWidth(String rowLabelWidth)`
`void`	`setRowStatus(SectionRow row, int status, String localizedMsg)`
`void`	`setSectionHeaderStatus(Section section, int status)`
`void`	`setSectionPanelLabelRenderer(SectionPanelLabelRenderer sectionPanelLabelRenderer)`
`void`	`setSectionRenderer(SectionRenderer sectionRenderer)`
`void`	`setSectionRowRenderer(SectionRowRenderer sectionRowRenderer)`
`void`	`setSectionsChangeAllowed(boolean sectionsChangeAllowed)`
`void`	`setSelectedRow(SectionRow selectedRow)`
`void`	`setSelectedRow(SectionRow selectedRow, boolean highlight)`
`protected void`	`unregisterRowComponents(Section section)`
`protected void`	`updateMode(Component parent)`
`protected void`	`updateSectionPositions()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- CLASS_SECTION_SELECTED_ROW
```
public static final String CLASS_SECTION_SELECTED_ROW
```
  See Also:
  
  Constant Field Values
- FOCUSABLE_COMPONENT
```
public static final String FOCUSABLE_COMPONENT
```
  See Also:
  
  Constant Field Values
- ON_SECTION_REMOVED
```
public static final String ON_SECTION_REMOVED
```
  See Also:
  
  Constant Field Values
- ON_SECTION_MOVED
```
public static final String ON_SECTION_MOVED
```
  See Also:
  
  Constant Field Values
- ON_SECTION_ADDED
```
public static final String ON_SECTION_ADDED
```
  See Also:
  
  Constant Field Values
- ON_SECTION_HIDE
```
public static final String ON_SECTION_HIDE
```
  See Also:
  
  Constant Field Values
- ON_SECTION_LABEL_CHANGE
```
public static final String ON_SECTION_LABEL_CHANGE
```
  See Also:
  
  Constant Field Values
- ON_SECTION_SHOW
```
public static final String ON_SECTION_SHOW
```
  See Also:
  
  Constant Field Values
- ON_SECTION_OPEN
```
public static final String ON_SECTION_OPEN
```
  See Also:
  
  Constant Field Values
- ON_SECTION_CLOSED
```
public static final String ON_SECTION_CLOSED
```
  See Also:
  
  Constant Field Values
- ON_SECTIONS_EXPANDED
```
public static final String ON_SECTIONS_EXPANDED
```
  See Also:
  
  Constant Field Values
- ON_SECTIONS_COLLAPSED
```
public static final String ON_SECTIONS_COLLAPSED
```
  See Also:
  
  Constant Field Values
- ON_ROW_HIDE
```
public static final String ON_ROW_HIDE
```
  See Also:
  
  Constant Field Values
- ON_ROW_SHOW
```
public static final String ON_ROW_SHOW
```
  See Also:
  
  Constant Field Values
- ON_ROW_MOVED
```
public static final String ON_ROW_MOVED
```
  See Also:
  
  Constant Field Values
- ON_ALL_ROWS_SHOW
```
public static final String ON_ALL_ROWS_SHOW
```
  See Also:
  
  Constant Field Values
- ON_ALL_SECTIONS_SHOW
```
public static final String ON_ALL_SECTIONS_SHOW
```
  See Also:
  
  Constant Field Values
- ON_MESSAGE_CLICKED
```
public static final String ON_MESSAGE_CLICKED
```
  See Also:
  
  Constant Field Values
- ON_MESSAGE_HIDE
```
public static final String ON_MESSAGE_HIDE
```
  See Also:
  
  Constant Field Values
- ON_ALL_MESSAGE_SHOW
```
public static final String ON_ALL_MESSAGE_SHOW
```
  See Also:
  
  Constant Field Values
- SECTION_ROW
```
public static final String SECTION_ROW
```
  See Also:
  
  Constant Field Values
- SECTION_NAME
```
public static final String SECTION_NAME
```
  See Also:
  
  Constant Field Values
- PERSP_TAG
```
protected static final String PERSP_TAG
```
  Jumping url stuff for "change constraint" feature
  
  See Also:
  
  Constant Field Values
- PERSP_ID
```
protected static final String PERSP_ID
```
  See Also:
  
  Constant Field Values
- EVENT_TAG
```
protected static final String EVENT_TAG
```
  See Also:
  
  Constant Field Values
- NAVIGATION_EVENT
```
protected static final String NAVIGATION_EVENT
```
  See Also:
  
  Constant Field Values
- PNAV_CONSTRAINT
```
protected static final String PNAV_CONSTRAINT
```
  See Also:
  
  Constant Field Values

Constructor Detail
- SectionPanel
```
public SectionPanel()
```

Method Detail

registerSectionComponent

protected void registerSectionComponent(Section section,
                                        SectionPanel.SectionComponent comp)

getSectionComponent

public SectionPanel.SectionComponent getSectionComponent(Section section)

registerRowComponent

protected void registerRowComponent(Section section,
                                    SectionRow row,
                                    SectionPanel.SectionRowComponent comp)

unregisterRowComponents

protected void unregisterRowComponents(Section section)

getRowComponent

protected SectionPanel.SectionRowComponent getRowComponent(SectionRow row)

getContextMenu
```
protected Menupopup getContextMenu()
```

getSectionContainer

protected Component getSectionContainer()

getSectionContainerDiv

protected Component getSectionContainerDiv()

getMainBorderlayout

protected Component getMainBorderlayout()

getMessageContainer

protected Component getMessageContainer()

getLabelContainer

protected Component getLabelContainer()

getInfoContainer

protected Component getInfoContainer()

createRowComponent

public HtmlBasedComponent createRowComponent(Section section,
                                             SectionRow row,
                                             Component rowContainer,
                                             Component sectionContentContainer)

renderRowValue

protected void renderRowValue(Component valueContainer,
                              SectionRow row)

renderRowValue

protected void renderRowValue(Component valueContainer,
                              SectionRow row,
                              boolean useRowRenderer)

createRowComponent

public SectionPanel.SectionRowComponent createRowComponent(Section section,
                                                           SectionRow row,
                                                           Component rowContainer,
                                                           Component sectionContentContainer,
                                                           String labelWidth)

createRowValueContainer

protected Div createRowValueContainer(SectionRow row)

createRowContextMenu

protected Menupopup createRowContextMenu(SectionRow row,
                                         Section section)

collapseAllSections

protected void collapseAllSections(SectionPanel.SectionComponent exclude)

expandAllSections
```
protected void expandAllSections()
```

appendPanelSpecificMenuItems

protected void appendPanelSpecificMenuItems(Menupopup menuPopUp)

appendSectionSpecificMenuItems

protected void appendSectionSpecificMenuItems(Menupopup menuPopUp,
                                              Section section)

createRowsMenu

protected Menu createRowsMenu(Section section)

resetRowsMenu

protected void resetRowsMenu(SectionPanel panel,
                             Section section,
                             Menupopup nmp)

appendViewSettingsMenu

protected void appendViewSettingsMenu(Menupopup menuPopUp)

createSectionContextMenu

protected Menupopup createSectionContextMenu(Section section)

getLabel
```
public String getLabel()
```

getImageUrl
```
public String getImageUrl()
```

getMessages
```
public List<Message> getMessages()
```

getAllSectionComponents

protected List<SectionPanel.SectionComponent> getAllSectionComponents()

setSectionRowRenderer

public void setSectionRowRenderer(SectionRowRenderer sectionRowRenderer)

getSectionRowRenderer

public SectionRowRenderer getSectionRowRenderer()

getSectionRenderer

public SectionRenderer getSectionRenderer()

setSectionRenderer

public void setSectionRenderer(SectionRenderer sectionRenderer)

setModel

public void setModel(SectionPanelModel model)

resetSectionMenu

protected void resetSectionMenu(Menu menu)

resetInfoContainer
```
protected void resetInfoContainer()
```

updateSectionPositions

protected void updateSectionPositions()

onPortalMoved

public void onPortalMoved(PortalMoveEvent event)

onDrop
```
public void onDrop(DropEvent event)
```

onShowAllMessages
```
public void onShowAllMessages()
```

afterCompose
```
public void afterCompose()
```

resetView
```
protected void resetView()
```

getModel
```
public SectionPanelModel getModel()
```

doSectionRemoved

protected void doSectionRemoved(Section section)

doSectionHidden

protected void doSectionHidden(Section section)

doSectionShown

protected void doSectionShown(Section section)

doSectionUpdated

protected void doSectionUpdated(Section section)

doSectionAdded

protected void doSectionAdded(Section section)

getSection

protected Section getSection(SectionRow row)

doRowUpdated

protected void doRowUpdated(SectionRow row)

doRowHidden

protected void doRowHidden(SectionRow row)

doRowShown

protected void doRowShown(SectionRow row)

onCtrlKey

public void onCtrlKey(KeyEvent keyEvent)

handleKeyDown
```
public void handleKeyDown()
```

highlightRow

protected void highlightRow(SectionRow sectionRow)

setRowStatus

public void setRowStatus(SectionRow row,
                         int status,
                         String localizedMsg)

setSectionHeaderStatus

public void setSectionHeaderStatus(Section section,
                                   int status)

attacheValidationMenupopup

public void attacheValidationMenupopup(SectionRow row,
                                       Menupopup menuPopup)

getAllRows
```
public Set<SectionRow> getAllRows()
```

getNextVisibleRow

protected SectionRow getNextVisibleRow(SectionRow row)

focusNext

public void focusNext(SectionRow row,
                      String nextIso)

setSelectedRow

public void setSelectedRow(SectionRow selectedRow)

setSelectedRow

public void setSelectedRow(SectionRow selectedRow,
                           boolean highlight)

getSelectedRow
```
public SectionRow getSelectedRow()
```

setMessageBoxRenderer

public void setMessageBoxRenderer(MessageBoxRenderer messageBoxRenderer)

getMessageBoxRenderer

public MessageBoxRenderer getMessageBoxRenderer()

setAlternateOpen

public void setAlternateOpen(boolean alternateOpen)

isAlternateOpen
```
public boolean isAlternateOpen()
```

setFlatSectionLayout

public void setFlatSectionLayout(boolean flatSectionLayout)

isFlatSectionLayout
```
public boolean isFlatSectionLayout()
```

detach
```
public void detach()
```

updateMode

protected void updateMode(Component parent)

isCollectionReference

protected boolean isCollectionReference(PropertyDescriptor propertyDescriptor)

desktopRemoved
```
public void desktopRemoved(Desktop desktop)
```
Specified by:

desktopRemoved in interface DesktopRemovalAwareComponent

onPageDetached

public void onPageDetached(Page page)

setRowLabelWidth

public void setRowLabelWidth(String rowLabelWidth)

getRowLabelWidth
```
public String getRowLabelWidth()
```

setSectionPanelLabelRenderer

public void setSectionPanelLabelRenderer(SectionPanelLabelRenderer sectionPanelLabelRenderer)

getSectionPanelLabelRenderer

public SectionPanelLabelRenderer getSectionPanelLabelRenderer()

setLazyLoad

public void setLazyLoad(boolean lazyLoad)

isLazyLoad
```
public boolean isLazyLoad()
```

setEditMode

public void setEditMode(boolean editMode)

isEditMode
```
public boolean isEditMode()
```

setSectionsChangeAllowed

public void setSectionsChangeAllowed(boolean sectionsChangeAllowed)

isSectionsChangeAllowed

public boolean isSectionsChangeAllowed()

Class SectionPanel

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_SECTION_SELECTED_ROW

FOCUSABLE_COMPONENT

ON_SECTION_REMOVED

ON_SECTION_MOVED

ON_SECTION_ADDED

ON_SECTION_HIDE

ON_SECTION_LABEL_CHANGE

ON_SECTION_SHOW

ON_SECTION_OPEN

ON_SECTION_CLOSED

ON_SECTIONS_EXPANDED

ON_SECTIONS_COLLAPSED

ON_ROW_HIDE

ON_ROW_SHOW

ON_ROW_MOVED

ON_ALL_ROWS_SHOW

ON_ALL_SECTIONS_SHOW

ON_MESSAGE_CLICKED

ON_MESSAGE_HIDE

ON_ALL_MESSAGE_SHOW

SECTION_ROW

SECTION_NAME

PERSP_TAG

PERSP_ID

EVENT_TAG

NAVIGATION_EVENT

PNAV_CONSTRAINT

Constructor Detail

SectionPanel

Method Detail

registerSectionComponent

getSectionComponent

registerRowComponent

unregisterRowComponents

getRowComponent

getContextMenu

getSectionContainer

getSectionContainerDiv

getMainBorderlayout

getMessageContainer

getLabelContainer

getInfoContainer

createRowComponent

renderRowValue

renderRowValue

createRowComponent

createRowValueContainer

createRowContextMenu

collapseAllSections

expandAllSections

appendPanelSpecificMenuItems

appendSectionSpecificMenuItems

createRowsMenu

resetRowsMenu

appendViewSettingsMenu

createSectionContextMenu

getLabel

getImageUrl

getMessages

getAllSectionComponents

setSectionRowRenderer

getSectionRowRenderer

getSectionRenderer

setSectionRenderer

setModel

resetSectionMenu

resetInfoContainer

updateSectionPositions

onPortalMoved

onDrop

onShowAllMessages

afterCompose

resetView