de.hybris.platform.hmc.webchips

Class AbstractChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

Direct Known Subclasses:

AbstractActionChip, AbstractAttributeEditorChip, AbstractAttributeValueChip, AbstractClassificationAttributeEditorChip, AbstractDialogChip, AbstractEditorMenuChip, AbstractLuceneSearchChip, AbstractOrganizerChip, AbstractTabChip, AbstractToolbarActionChip, AbstractToolbarChip, AbstractTreeNodeChip, ActionResultChip, AttributeChip, Blank, CatalogContentChip, ContentBlockPreviewChip, CronJobContentChip, CustomChip, DefaultContent, DialogContainerChip, DirectoryViewChip, EditorTabChip, EnumerationValueUsageFinderChip, ExplorerChip, FileDownloadChip, FlexibleConditionChip, Frame, FrameSet, GenericExplorerMenuTreeNodeContentChip, GenericLayoutChip, GenericSearchChip, GenericShortcutChip, GenericTabEditorChip, GenericTableChip, GenericTRChip, HolderChip, IconChip, IconViewChip, InlineShortcutChip, ItemChip, ItemCreateTypeSelectChip, ItemHistoryChip, LinkShortcutChip, ListChip, ListEntryChip, ListOperationChip, LogOutChip, LucenesearchContentChip, MainChip, MediaFileUploadEditorChip, MenuChip, MenuTabChip, ModalMediaFileUploadChip, NoAccessChip, OrganizerCreateChip, PasswordEditorChip, PrincipalAccessRightsEditorChip, PrintContainerChip, ProductComparisonChip, SavedValueEntryEditorChip, SearchGroupChip, SearchResultChip, SearchResultNavigationChip, SimpleTreeCellDisplayChip, SocketChip, SpecialShortcutChip, StaticContentChip, StructureEditorChip, TextChip, TreeChip, TreeChip.TreeNodeChip, TreeViewChip, TriggerTimeValuesEditorChip, TypeAccessRightsEditorChip, TypeExportContentChip, VoucherEditorChip

public abstract class AbstractChip
extends Object
implements Chip

This is the base class which helps implementing the Chip interface.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHIP_KEY
static String	FALSE
static String	FRAME_KEY
static String	SHOW_JSP_COMMENTS Deprecated. use ConfigConstants.DEBUG_SHOWJSPCOMMENTS directly
static String	TRUE
static String	USE_SOCKET_NAMING

Fields inherited from interface de.hybris.platform.hmc.webchips.Chip

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
AbstractChip(DisplayState displayState, Chip parent)

Method Summary

Modifier and Type	Method and Description
void	addEventListener(String topic, ChipEventListener listener)
void	checkValid() Gives the chip the possibility to check if its objects are still valid.
protected void	clearInfoMessages()
Object	clone()
boolean	containsDisplayEvent(Map<String,List<String>> events)
String	createMenuEntriesForJS(List<MenuEntry> menuEntries)
void	dispose() called when its display state is unbound from its http session.
protected boolean	errorQueueEmpty() Deprecated. Please use isErrorQueueEmpty() instead.
protected Object	getClipboard() Gets an Object from the WebChips-clipboard
String	getCommandID(String eventID) Convenience method.
String	getDisplayParameters() The default implementation returns Null since this feature is not supported by default.
DisplayState	getDisplayState() Returns the current DisplayState.
String	getEventID(String eventID) Convenience method.
String	getEventURL(String eventID, String value)
String	getEventValue(String eventID, String value) Chips that translate event values (i.e.
protected Frame	getFrame() Tries to find the surrounding frame.
String	getID()
protected List<String>	getInfoMessages()
JaloSession	getJaloSession() Returns the current JaloSession.
static String	getLocalizedString(String strKey) Returns a localized string for the given key or the key itself if no localized string was found.
static String	getLocalizedString(String pattern, Object... arguments)
Logger	getLogger()
List<MenuEntry>	getMenuEntries() Here you can specify what Actions you are able to perform at the moment.
String	getNameSpace()
static String	getNameSpaceFor(Chip chip)
Chip	getParent() Returns the parent if there is one
protected String	getProposedUniqueName()
protected static String	getProposedUniqueNameFor(Chip chip) Use this static method from within deeply nested chips if you need to have a 'clean' unique name.
boolean	getRequestFocus() Gets the current request focus flag and resets it to false.
protected String	getSessionIdentifier()
String	getStringValue(Map<String,List<String>> events, String event)
String	getUniqueName()
Window	getWindow() Tries to find the surrounding window
void	goFullScreen() As a result of this call your chip will be displayed fullscreen.
boolean	hasVisibleContextMenuEntries()
boolean	isButtonPushed(List<String> eventValues, String eventName)
boolean	isButtonPushed(Map<String,List<String>> eventValueMap, String buttonName)
protected boolean	isErrorQueueEmpty()
boolean	isValid() Returns whether the chip is still valid In contrast to checkValid() it doesn't actually ask its objects but just returns the state set in checkValid()
void	leaveFullScreen() As a result of this call your chip will not be displayed fullscreen any longer.
protected void	notifyEventListeners(ChipEvent event)
protected void	notifyEventListeners(Map<String,List<String>> events) All events contained in the given map will be dispatched to their appropriate event listeners.
protected void	postErrorMessage(String error) Posts error messages to the error handler Usually these error messages will be displayed as popup windows.
protected void	postInfoMessage(String info) Posts info messages to the error handler Usually these info messages will be displayed as popup windows.
protected void	postWindowEvent(WindowEvent event) Posts WindowEvents to the handler
protected void	refresh()
protected void	refreshChild(Chip child)
String	registerUniqueName(String proposedName, Chip chip)
void	removeEventListener(String topic, ChipEventListener listener)
protected void	removeInfoMessage(int pos)
void	render(HttpServletRequest request, HttpServletResponse response) Is used to render the chip.
void	render(PageContext context) Call this method from inside a JSP.
protected void	setClipboard(Object object) Puts an Object into the WebChips-clipboard
protected void	setParent(Chip parent)
void	setRequestFocus(boolean focus) Sets the request focus flag.
protected void	setValid(boolean valid) Sets whether the chips is still valid
protected void	setWindowStatus(String status)
String	translateFormFieldToEventName(String formFieldName) used for macro testing; translate a JSP form field name (may be PK) to the name used in macro file step elements Don't use the jalosession or change the internal state of the chip here!!!
String	translateFormFieldToEventValue(String formFieldName, String formFieldValue) used for macro testing; translate a JSP form field value (may be PK) to the value used in macro file step elements Don't use the jalosession or change the internal state of the chip here!!!

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.hmc.webchips.Chip

getJSPURI, processEvents

Field Detail

USE_SOCKET_NAMING

public static final String USE_SOCKET_NAMING

See Also:

Constant Field Values

CHIP_KEY

public static final String CHIP_KEY

See Also:

Constant Field Values

FRAME_KEY

public static final String FRAME_KEY

See Also:

Constant Field Values

SHOW_JSP_COMMENTS

@Deprecated
public static final String SHOW_JSP_COMMENTS

Deprecated. use ConfigConstants.DEBUG_SHOWJSPCOMMENTS directly

See Also:

Constant Field Values

TRUE

public static final String TRUE

See Also:

Constant Field Values

FALSE

public static final String FALSE

See Also:

Constant Field Values

Constructor Detail

AbstractChip

public AbstractChip(DisplayState displayState,
                    Chip parent)

Method Detail

dispose

public void dispose()

Description copied from interface: Chip

called when its display state is unbound from its http session. this means it is no longer used.

Specified by:

dispose in interface Chip

getProposedUniqueNameFor

protected static final String getProposedUniqueNameFor(Chip chip)

Use this static method from within deeply nested chips if you need to have a 'clean' unique name.

Since:

3.00 (beta1)

getProposedUniqueName

protected String getProposedUniqueName()

getUniqueName

public final String getUniqueName()

Specified by:

getUniqueName in interface Chip

registerUniqueName

public final String registerUniqueName(String proposedName,
                                       Chip chip)

Specified by:

registerUniqueName in interface Chip

getNameSpace

public final String getNameSpace()

getNameSpaceFor

public static final String getNameSpaceFor(Chip chip)

Since:

3.00 (beta1)

getMenuEntries

public List<MenuEntry> getMenuEntries()

Here you can specify what Actions you are able to perform at the moment. Should be overridden in sub classes.

Specified by:

getMenuEntries in interface Chip

Returns:

List of Actions;

hasVisibleContextMenuEntries

public boolean hasVisibleContextMenuEntries()

createMenuEntriesForJS

public final String createMenuEntriesForJS(List<MenuEntry> menuEntries)

Parameters:

menuEntries -

Returns:

a String contains JavaScript menu entries

Since:

2.20

getDisplayState

public final DisplayState getDisplayState()

Returns the current DisplayState.

Specified by:

getDisplayState in interface Chip

getLocalizedString

public static String getLocalizedString(String strKey)

Returns a localized string for the given key or the key itself if no localized string was found.
Calls DisplayState.getLocalizedString(String) on the current DisplayState.

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].

getLocalizedString

public static String getLocalizedString(String pattern,
                                        Object... arguments)

Since:

2.30

getID

public final String getID()

Specified by:

getID in interface Chip

getJaloSession

public final JaloSession getJaloSession()

Returns the current JaloSession.

Specified by:

getJaloSession in interface Chip

goFullScreen

public void goFullScreen()

As a result of this call your chip will be displayed fullscreen.

Specified by:

goFullScreen in interface Chip

leaveFullScreen

public void leaveFullScreen()

As a result of this call your chip will not be displayed fullscreen any longer. Does throw a RuntimeException if you are not fullscreen.

Specified by:

leaveFullScreen in interface Chip

render

public final void render(HttpServletRequest request,
                         HttpServletResponse response)
                  throws ServletException,
                         IOException

Is used to render the chip. Since you cannot override this method your only chance to change the jsp is to implement getJSPURI accordingly. You are forced to anyway :)

Throws:

ServletException

IOException

getEventID

public final String getEventID(String eventID)

Convenience method. Encodes chip class, chip id and event id. Use it to generate input field names and link parameters.

Specified by:

getEventID in interface Chip

getCommandID

public final String getCommandID(String eventID)

Convenience method. Encodes chip class, chip id and event id. Use it to generate command links (will be processed after all events have been processed)

Specified by:

getCommandID in interface Chip

getEventValue

public final String getEventValue(String eventID,
                                  String value)

Chips that translate event values (i.e. implement translateFormFieldToEventValue(String,String)) must register the values using this method.

Specified by:

getEventValue in interface Chip

getEventURL

public String getEventURL(String eventID,
                          String value)

Specified by:

getEventURL in interface Chip

render

public final void render(PageContext context)
                  throws ServletException,
                         IOException

Call this method from inside a JSP. It calls the render method you have to implement. It also flushes the out stream before doing so.

Specified by:

render in interface Chip

Throws:

ServletException

IOException

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

setClipboard

protected void setClipboard(Object object)

Puts an Object into the WebChips-clipboard

getClipboard

protected final Object getClipboard()

Gets an Object from the WebChips-clipboard

postErrorMessage

protected final void postErrorMessage(String error)

Posts error messages to the error handler Usually these error messages will be displayed as popup windows.

postInfoMessage

protected final void postInfoMessage(String info)

Posts info messages to the error handler Usually these info messages will be displayed as popup windows.

getInfoMessages

protected List<String> getInfoMessages()

Returns:

all currently queued info messages.

removeInfoMessage

protected void removeInfoMessage(int pos)
                          throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

clearInfoMessages

protected void clearInfoMessages()

isErrorQueueEmpty

protected final boolean isErrorQueueEmpty()

errorQueueEmpty

@Deprecated
protected final boolean errorQueueEmpty()

Deprecated. Please use isErrorQueueEmpty() instead.

Since:

2.30

postWindowEvent

protected final void postWindowEvent(WindowEvent event)

Posts WindowEvents to the handler

getParent

public final Chip getParent()

Returns the parent if there is one

Specified by:

getParent in interface Chip

getFrame

protected final Frame getFrame()

Tries to find the surrounding frame.

Returns:

The frame of the chip or NULL if the chip is not part of a frame.

getWindow

public Window getWindow()

Tries to find the surrounding window

Returns:

The window of the chip or NULL if the chip is not part of a window.

translateFormFieldToEventName

public String translateFormFieldToEventName(String formFieldName)

Description copied from interface: Chip

used for macro testing; translate a JSP form field name (may be PK) to the name used in macro file step elements Don't use the jalosession or change the internal state of the chip here!!!

Specified by:

translateFormFieldToEventName in interface Chip

translateFormFieldToEventValue

public String translateFormFieldToEventValue(String formFieldName,
                                             String formFieldValue)

Description copied from interface: Chip

used for macro testing; translate a JSP form field value (may be PK) to the value used in macro file step elements Don't use the jalosession or change the internal state of the chip here!!!

Specified by:

translateFormFieldToEventValue in interface Chip

checkValid

public void checkValid()

Gives the chip the possibility to check if its objects are still valid. If you override this method, call super.checkValid()

Specified by:

checkValid in interface Chip

setValid

protected final void setValid(boolean valid)

Sets whether the chips is still valid

isValid

public final boolean isValid()

Description copied from interface: Chip

Returns whether the chip is still valid In contrast to checkValid() it doesn't actually ask its objects but just returns the state set in checkValid()

Specified by:

isValid in interface Chip

Returns:

true if still valid false if not

refresh

protected void refresh()

refreshChild

protected void refreshChild(Chip child)

setParent

protected final void setParent(Chip parent)

addEventListener

public void addEventListener(String topic,
                             ChipEventListener listener)

Specified by:

addEventListener in interface Chip

removeEventListener

public void removeEventListener(String topic,
                                ChipEventListener listener)

Specified by:

removeEventListener in interface Chip

notifyEventListeners

protected void notifyEventListeners(ChipEvent event)

notifyEventListeners

protected void notifyEventListeners(Map<String,List<String>> events)

All events contained in the given map will be dispatched to their appropriate event listeners.
The given map should contain chip events from the processEvents() cycle. I.e. it must contain [String -> List of Strings] mappings.
If an event listener is registered for a given event name, it will be notified and receives a ChipEvent object containing following:
source: this chip
topic: the event name
value: the List of Strings (usually there will be only one string in this list, containing something like 'true' or some user input)

Since:

2.30

getSessionIdentifier

protected String getSessionIdentifier()

setWindowStatus

protected void setWindowStatus(String status)

isButtonPushed

public boolean isButtonPushed(Map<String,List<String>> eventValueMap,
                              String buttonName)

isButtonPushed

public boolean isButtonPushed(List<String> eventValues,
                              String eventName)

getStringValue

public String getStringValue(Map<String,List<String>> events,
                             String event)

getLogger

public Logger getLogger()

containsDisplayEvent

public boolean containsDisplayEvent(Map<String,List<String>> events)

getDisplayParameters

public String getDisplayParameters()

The default implementation returns Null since this feature is not supported by default.

Specified by:

getDisplayParameters in interface Chip

Returns:

Parameters the chip needs to restore its current display status. Currently these parameters are used by the PRG (Post-Redirect-Get Pattern) request, if the user uses back-functionality of the browser.

See Also:

Chip.getDisplayParameters()

setRequestFocus

public void setRequestFocus(boolean focus)

Sets the request focus flag. If set, getRequestFocus() will return true. Use that flag for indicating that at next request the caller of getRequestFocus() has to set the focus.

Parameters:

focus - true for setting the request focus, otherwise false

Since:

3.0-u2

getRequestFocus

public boolean getRequestFocus()

Gets the current request focus flag and resets it to false.

Returns:

true if the caller has to set the focus, otherwise false

Since:

3.0-u2