DisplayState (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.webchips.DisplayState

All Implemented Interfaces:

Serializable
```
public class DisplayState
extends Object
implements Serializable
```
Stores information for a display state including a complete set of chips. Handles events and manages the weak referencing of Chips. Note: Event values are not encoded and therfore special characters can be stored to the database. This enables malicious code to be stored and later executed. For enabling encoding for a special event, the event id must start with Chip.FILTERED_PREFIX.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMMAND_EVENT`
`static String`	`COMMAND_PREFIX`
`static char`	`DELIMITER`
`static String`	`EVENT_EVENT`
`static int`	`MAX_ITEM_HISTORY`
`static String`	`RESOURCE_BASENAME`
`Map<String,Chip>`	`theChips`
`static String`	`TRANSLATION_CHIPID`
`static String`	`TRANSLATION_REALID`
`static String`	`TRANSLATION_REALVALUE`
`static String`	`TRANSLATION_TRANSLATEDID`
`static String`	`TRANSLATION_TRANSLATEDVALUE`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DisplayState(HttpSession session, MasterServlet masterServlet, JaloSession jaloSession, String remoteHost, String remoteUser)` Creates a new DisplayState which does not have a predecessor.
`protected`	`DisplayState(HttpSession session, MasterServlet masterServlet, JaloSession jaloSession, String prefix, String remoteHost, String remoteUser)` Creates a new DisplayState which does not have a predecessor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addErrorMessage(String error)` Posts error messages to the error handler Usually these error messages will be displayed as popup windows.
`void`	`addExtraParamHandler(ExtraParamHandler handler)`
`void`	`addInfoMessage(String info)` Posts info messages to the error handler Usually these info messages will be displayed as popup windows.
`void`	`addItemCreationListener(ItemCreationListener listener)` Adds an `ItemCreationListener` to this DisplayState (=session) which will be notified whenever an Item of a certain (sub-)type is created.
`void`	`addItemToHistory(Item item)`
`void`	`addLanguageChangeListener(LanguageChangeListener listener)`
`void`	`addLanguageCreationListener(LanguageCreationListener listener)`
`protected void`	`addWindowEvent(WindowEvent event)` Posts WindowEvents to the handler
`void`	`clearErrorMessages()` Removes all error messages.
`void`	`clearInfoMessages()` Removes all info messages.
`protected void`	`discard()`
`void`	`dispose()` called when this state is unbound from its http session.
`static String`	`encodeHTML(String input)` Deprecated. since 2.0. use de.hybris.platform.util.Utilities#escapeHTML( String ) instead.
`boolean`	`errorQueueEmpty()`
`void`	`extractEventsFromParameters(Map<String,String[]> requestParameters, boolean prgRequest)` Extracts all webchip events from the request parameters and adds them to the event map of the corresponding webchip.
`Object`	`getAttribute(String key)` Returns the attribute for the given key or null.
`Chip`	`getChip(String id)` Returns the chip with the given id.
`String`	`getChipPrefix()`
`Object`	`getClipboard()` Gets an Object from the WebChips-clipboard
`static DisplayState`	`getCurrent()`
`Window`	`getDefaultWindow()` Creates a default window.
`List`	`getErrorMessages()` Returns a list of all error messages.
`protected Frame`	`getFrame(String id)` Returns a Frame with the given id.
`List<String>`	`getInfoMessages()` Returns a list of all info messages.
`protected List<WeakReference<ItemCreationListener>>`	`getItemCreationListeners()` See `addItemCreationListener(ItemCreationListener)`.
`List<Item>`	`getItemHistory()`
`JaloSession`	`getJaloSession()`
`protected List<WeakReference<LanguageChangeListener>>`	`getLanguageChangeListeners()`
`protected List<WeakReference<LanguageCreationListener>>`	`getLanguageCreationListeners()`
`Locale`	`getLocale()`
`String`	`getLocalizedString(String strKey)` Returns a localized string for the given key or the key itself if no localized string were found.
`String`	`getLocalizedString(String strKey, Object[] arguments)` Returns a localized string for the given key or the key itself if no localized string were found.
`protected String`	`getLocalizedStringInternal(String key)`
`String`	`getRemoteHost()`
`String`	`getRemoteUser()`
`HttpServletRequest`	`getRequest()` Returns the current `HttpServletRequest`, if called during event processing.
`HttpServletResponse`	`getResponse()` Returns the current `HttpServletResponse`, if called during event processing.
`Map<String,List<String>>`	`getUnparseableParameters()` Returns the parameters from the last request which could not be parsed (outside parameters)
`protected Window`	`getWindow(String chipID)` Returns a Window with the given id.
`List<WindowEvent>`	`getWindowEvents()` Returns a list of all WindowEvents.
`protected void`	`handleUnparseableParameters()` Calls handleExtraParams() on all registered ExtraParamHandlers with the current map of unparseable parameters.
`void`	`notifyItemCreation(ItemCreationEvent event)` See `addItemCreationListener(ItemCreationListener)`
`void`	`notifyLanguageChange(LanguageChangeEvent event)`
`void`	`notifyLanguageCreation(LanguageCreationEvent event)`
`protected void`	`processEvents(HttpServletRequest request, boolean prgRequest)` Process all those Events in the request which can be recognized as valid
`String`	`register(Chip aChip)` Creates a unique id and registers it for events
`String`	`registerChipName(String proposedName, Chip chip)`
`void`	`removeInfoMessage(int pos)`
`protected void`	`render(String windowID, HttpServletRequest request, HttpServletResponse response)` Renders the content of the Window with the given id.
`void`	`setAttribute(String key, Object value)` Sets an attribute which is visible in this session only.
`void`	`setClipboard(Object object)` Puts an Object into the WebChips-clipboard.
`static void`	`setCurrent(DisplayState state)`
`static void`	`unsetCurrent()`

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

- Field Detail
  - COMMAND_PREFIX
```
public static final String COMMAND_PREFIX
```
    See Also:
    
    Constant Field Values
  - DELIMITER
```
public static final char DELIMITER
```
    See Also:
    
    Constant Field Values
  - TRANSLATION_CHIPID
```
public static final String TRANSLATION_CHIPID
```
    See Also:
    
    Constant Field Values
  - TRANSLATION_REALID
```
public static final String TRANSLATION_REALID
```
    See Also:
    
    Constant Field Values
  - TRANSLATION_TRANSLATEDID
```
public static final String TRANSLATION_TRANSLATEDID
```
    See Also:
    
    Constant Field Values
  - TRANSLATION_REALVALUE
```
public static final String TRANSLATION_REALVALUE
```
    See Also:
    
    Constant Field Values
  - TRANSLATION_TRANSLATEDVALUE
```
public static final String TRANSLATION_TRANSLATEDVALUE
```
    See Also:
    
    Constant Field Values
  - EVENT_EVENT
```
public static final String EVENT_EVENT
```
    See Also:
    
    Constant Field Values
  - COMMAND_EVENT
```
public static final String COMMAND_EVENT
```
    See Also:
    
    Constant Field Values
  - RESOURCE_BASENAME
```
public static final String RESOURCE_BASENAME
```
    See Also:
    
    Constant Field Values
  - theChips
```
public Map<String,Chip> theChips
```
  - MAX_ITEM_HISTORY
```
public static final int MAX_ITEM_HISTORY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DisplayState
```
protected DisplayState(HttpSession session,
                       MasterServlet masterServlet,
                       JaloSession jaloSession,
                       String prefix,
                       String remoteHost,
                       String remoteUser)
```
    Creates a new DisplayState which does not have a predecessor. Does also load the chip class codes if necessary.
    
    Parameters:
    
    prefix - the prefix of chip ids
  - DisplayState
```
protected DisplayState(HttpSession session,
                       MasterServlet masterServlet,
                       JaloSession jaloSession,
                       String remoteHost,
                       String remoteUser)
```
    Creates a new DisplayState which does not have a predecessor. Does also load the chip class codes if necessary.
- Method Detail
  - setCurrent
```
public static final void setCurrent(DisplayState state)
```
  - getCurrent
```
public static final DisplayState getCurrent()
```
  - unsetCurrent
```
public static final void unsetCurrent()
```
  - dispose
```
public void dispose()
```
    called when this state is unbound from its http session. /* this means it is not used any more.
  - getJaloSession
```
public JaloSession getJaloSession()
```
    Returns:
    
    The current JaloSession
  - getWindow
```
protected final Window getWindow(String chipID)
```
    Returns a Window with the given id. If no such Window exists a new one will be created. Windows are the only chips which do not have to have a parent.
  - discard
```
protected void discard()
```
  - render
```
protected final void render(String windowID,
                            HttpServletRequest request,
                            HttpServletResponse response)
                     throws ServletException,
                            IOException
```
    Renders the content of the Window with the given id.
    
    Throws:
    
    ServletException
    
    IOException
  - processEvents
```
protected void processEvents(HttpServletRequest request,
                             boolean prgRequest)
```
    Process all those Events in the request which can be recognized as valid
  - extractEventsFromParameters
```
public final void extractEventsFromParameters(Map<String,String[]> requestParameters,
                                              boolean prgRequest)
```
    Extracts all webchip events from the request parameters and adds them to the event map of the corresponding webchip.
    
    Parameters:
    
    requestParameters - the requestParameters
  - setClipboard
```
public void setClipboard(Object object)
```
    Puts an Object into the WebChips-clipboard.
    
    See Also:
    
    AbstractChip.setClipboard(Object)
  - getClipboard
```
public Object getClipboard()
```
    Gets an Object from the WebChips-clipboard
    
    See Also:
    
    AbstractChip.getClipboard()
  - addErrorMessage
```
public void addErrorMessage(String error)
```
    Posts error messages to the error handler Usually these error messages will be displayed as popup windows.
    
    See Also:
    
    AbstractChip.postErrorMessage(String)
  - addInfoMessage
```
public void addInfoMessage(String info)
```
    Posts info messages to the error handler Usually these info messages will be displayed as popup windows.
    
    See Also:
    
    AbstractChip.postInfoMessage(String)
  - removeInfoMessage
```
public void removeInfoMessage(int pos)
                       throws IndexOutOfBoundsException
```
    Throws:
    
    IndexOutOfBoundsException
  - addWindowEvent
```
protected void addWindowEvent(WindowEvent event)
```
    Posts WindowEvents to the handler
    
    See Also:
    
    AbstractChip.postWindowEvent(WindowEvent)
  - getErrorMessages
```
public List getErrorMessages()
```
    Returns a list of all error messages.
  - errorQueueEmpty
```
public boolean errorQueueEmpty()
```
    Returns:
    
    true if at least one error message exists
  - clearErrorMessages
```
public void clearErrorMessages()
```
    Removes all error messages.
  - getInfoMessages
```
public List<String> getInfoMessages()
```
    Returns a list of all info messages.
  - clearInfoMessages
```
public void clearInfoMessages()
```
    Removes all info messages.
  - getWindowEvents
```
public List<WindowEvent> getWindowEvents()
```
    Returns a list of all WindowEvents. It is your turn to remove events from the list
  - getFrame
```
protected Frame getFrame(String id)
```
    Returns a Frame with the given id.
  - getLocalizedString
```
public String getLocalizedString(String strKey,
                                 Object[] arguments)
```
    Returns a localized string for the given key or the key itself if no localized string were found.
    The localized string will be processed by MessageFormat using given arguments.
    
    Parameters:
    
    strKey - the key to get a localized representation for.
    
    arguments - the arguments
    
    Returns:
    
    a localized string for the given key or the key enclosed in [] key -> [key].
    
    Since:
    
    2.20
  - getLocalizedString
```
public String getLocalizedString(String strKey)
```
    Returns a localized string for the given key or the key itself if no localized string were found.
    
    Parameters:
    
    strKey - the key to get a localized representation for.
    
    Returns:
    
    a localized string for the given key or the key enclosed in [] key -> [key].
  - getLocalizedStringInternal
```
protected String getLocalizedStringInternal(String key)
```
  - getChipPrefix
```
public String getChipPrefix()
```
  - register
```
public String register(Chip aChip)
```
    Creates a unique id and registers it for events
    
    Returns:
    
    your new id
  - getChip
```
public Chip getChip(String id)
```
    Returns the chip with the given id.
    
    Returns:
    
    a Chip object.
  - registerChipName
```
public String registerChipName(String proposedName,
                               Chip chip)
```
  - getAttribute
```
public Object getAttribute(String key)
```
    Returns the attribute for the given key or null.
  - setAttribute
```
public void setAttribute(String key,
                         Object value)
```
    Sets an attribute which is visible in this session only.
  - encodeHTML
```
@Deprecated
public static String encodeHTML(String input)
```
    Deprecated. since 2.0. use de.hybris.platform.util.Utilities#escapeHTML( String ) instead.
    
    Encodes HTML entities (", ', <, >, &). This prevents malicious script code from being executed.
  - getLocale
```
public Locale getLocale()
```
  - getUnparseableParameters
```
public Map<String,List<String>> getUnparseableParameters()
```
    Returns the parameters from the last request which could not be parsed (outside parameters)
  - getRemoteHost
```
public String getRemoteHost()
```
  - getRemoteUser
```
public String getRemoteUser()
```
  - handleUnparseableParameters
```
protected void handleUnparseableParameters()
```
    Calls handleExtraParams() on all registered ExtraParamHandlers with the current map of unparseable parameters.
  - addExtraParamHandler
```
public void addExtraParamHandler(ExtraParamHandler handler)
```
  - addLanguageChangeListener
```
public void addLanguageChangeListener(LanguageChangeListener listener)
```
    Since:
    
    2.30
  - getLanguageChangeListeners
```
protected List<WeakReference<LanguageChangeListener>> getLanguageChangeListeners()
```
    Since:
    
    2.30
  - notifyLanguageChange
```
public void notifyLanguageChange(LanguageChangeEvent event)
```
    Since:
    
    2.30
  - addLanguageCreationListener
```
public void addLanguageCreationListener(LanguageCreationListener listener)
```
    Since:
    
    3.0 M2
  - getLanguageCreationListeners
```
protected List<WeakReference<LanguageCreationListener>> getLanguageCreationListeners()
```
    Since:
    
    3.0 M2
  - notifyLanguageCreation
```
public void notifyLanguageCreation(LanguageCreationEvent event)
```
    Since:
    
    3.0 M2
  - addItemCreationListener
```
public void addItemCreationListener(ItemCreationListener listener)
```
    Adds an ItemCreationListener to this DisplayState (=session) which will be notified whenever an Item of a certain (sub-)type is created. The ItemCreationListener can provide a ComposedType via ItemCreationListener.getListeningType(). If this method returns null the listener will be notified of all item creations. If it, for example, returns the ComposedType 'Product' the listener will be notified whenever a new Product or any item which is a subtype of Product is created.
    
    Since:
    
    3.0 M3
  - getItemCreationListeners
```
protected List<WeakReference<ItemCreationListener>> getItemCreationListeners()
```
    See addItemCreationListener(ItemCreationListener).
    
    Since:
    
    3.0 M3
  - notifyItemCreation
```
public void notifyItemCreation(ItemCreationEvent event)
```
    See addItemCreationListener(ItemCreationListener)
    
    Since:
    
    3.0 M3
  - getRequest
```
public HttpServletRequest getRequest()
```
    Returns the current HttpServletRequest, if called during event processing. Otherwise null is returned.
    
    Returns:
    
    the current HttpServletRequest, if called during event processing. Otherwise null is returned
    
    Since:
    
    2.10
  - getResponse
```
public HttpServletResponse getResponse()
```
    Returns the current HttpServletResponse, if called during event processing. Otherwise null is returned.
    
    Returns:
    
    the current HttpServletResponse, if called during event processing. Otherwise null is returned
    
    Since:
    
    2.10
  - getItemHistory
```
public List<Item> getItemHistory()
```
    Since:
    
    3.00 (beta1)
  - addItemToHistory
```
public void addItemToHistory(Item item)
```
    Since:
    
    3.00 (beta1)
  - getDefaultWindow
```
public Window getDefaultWindow()
```
    Creates a default window.

Class DisplayState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMMAND_PREFIX

DELIMITER

TRANSLATION_CHIPID

TRANSLATION_REALID

TRANSLATION_TRANSLATEDID

TRANSLATION_REALVALUE

TRANSLATION_TRANSLATEDVALUE

EVENT_EVENT

COMMAND_EVENT

RESOURCE_BASENAME

theChips

MAX_ITEM_HISTORY

Constructor Detail

DisplayState

DisplayState

Method Detail

setCurrent

getCurrent

unsetCurrent

dispose

getJaloSession

getWindow

discard

render

processEvents

extractEventsFromParameters

setClipboard

getClipboard

addErrorMessage

addInfoMessage

removeInfoMessage

addWindowEvent

getErrorMessages

errorQueueEmpty

clearErrorMessages

getInfoMessages

clearInfoMessages

getWindowEvents

getFrame

getLocalizedString

getLocalizedString

getLocalizedStringInternal

getChipPrefix

register

getChip

registerChipName

getAttribute

setAttribute

encodeHTML

getLocale

getUnparseableParameters

getRemoteHost

getRemoteUser

handleUnparseableParameters

addExtraParamHandler

addLanguageChangeListener

getLanguageChangeListeners

notifyLanguageChange

addLanguageCreationListener

getLanguageCreationListeners

notifyLanguageCreation

addItemCreationListener

getItemCreationListeners

notifyItemCreation

getRequest

getResponse

getItemHistory

addItemToHistory

getDefaultWindow