de.hybris.platform.hmc.administration

Class StructureEditorChip

java.lang.Object

de.hybris.platform.hmc.webchips.AbstractChip

de.hybris.platform.hmc.administration.StructureEditorChip

All Implemented Interfaces:

Chip, Serializable, Cloneable

public class StructureEditorChip
extends AbstractChip

Chip for editing of the HMC structure (types xml).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESET
static String	SAVE_ERROR_MESSAGE
static String	STRUCTURE_LOAD_ERROR_MESSAGE
static int	TAB_SIZE
static String	TEXT
static String	UPLOADEDITOR
static String	UPLOADFILE
static String	VALIDATE
static String	VALIDATION_ERROR_MESSAGE
static String	VALIDATION_SUCCESS_MESSAGE

Fields inherited from class de.hybris.platform.hmc.webchips.AbstractChip

CHIP_KEY, FALSE, FRAME_KEY, SHOW_JSP_COMMENTS, TRUE, USE_SOCKET_NAMING

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

DISPLAY_EVENT, FILTERED_PREFIX

Constructor Summary

Constructors

Constructor and Description
StructureEditorChip(DisplayState displayState, Chip parent) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getConfirmXSDMessage() Returns a (localized) message if either the xsd url is not set or this url is not reachable/empty.
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
String	getStructure() Returns structure the chip currently holds.
String	getStructureQuoted() Returns structure the chip currently holds, but with encoded HTML entities.
String	getTitle() Returns title of this chip.
static boolean	isUsingDBForStructure() Returns true if the hmc is configured to load the hmc.xml from the database.
void	loadStructure() Loads structure from the database and stores it in the chip.
boolean	loadStructureFromFile() Loads structure from hmc.xml and stores it in this chip.
void	processEvents(Map events) Handles all incoming requests for this chip.
void	saveStructure() Saves current structure in the database.
void	setStructure(String structure) Sets structure the chip will be holding.
boolean	validateStructure(boolean saving) Validates the current structure without saving or changing anything.

Methods inherited from class de.hybris.platform.hmc.webchips.AbstractChip

addEventListener, checkValid, clearInfoMessages, clone, containsDisplayEvent, createMenuEntriesForJS, dispose, errorQueueEmpty, getClipboard, getCommandID, getDisplayParameters, getDisplayState, getEventID, getEventURL, getEventValue, getFrame, getID, getInfoMessages, getJaloSession, getLocalizedString, getLocalizedString, getLogger, getMenuEntries, getNameSpace, getNameSpaceFor, getParent, getProposedUniqueName, getProposedUniqueNameFor, getRequestFocus, getSessionIdentifier, getStringValue, getUniqueName, getWindow, goFullScreen, hasVisibleContextMenuEntries, isButtonPushed, isButtonPushed, isErrorQueueEmpty, isValid, leaveFullScreen, notifyEventListeners, notifyEventListeners, postErrorMessage, postInfoMessage, postWindowEvent, refresh, refreshChild, registerUniqueName, removeEventListener, removeInfoMessage, render, render, setClipboard, setParent, setRequestFocus, setValid, setWindowStatus, translateFormFieldToEventName, translateFormFieldToEventValue

Methods inherited from class java.lang.Object

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

Field Detail

UPLOADEDITOR

public static final String UPLOADEDITOR

See Also:

Constant Field Values

VALIDATE

public static final String VALIDATE

See Also:

Constant Field Values

RESET

public static final String RESET

See Also:

Constant Field Values

UPLOADFILE

public static final String UPLOADFILE

See Also:

Constant Field Values

TEXT

public static final String TEXT

See Also:

Constant Field Values

SAVE_ERROR_MESSAGE

public static final String SAVE_ERROR_MESSAGE

See Also:

Constant Field Values

VALIDATION_ERROR_MESSAGE

public static final String VALIDATION_ERROR_MESSAGE

See Also:

Constant Field Values

VALIDATION_SUCCESS_MESSAGE

public static final String VALIDATION_SUCCESS_MESSAGE

See Also:

Constant Field Values

STRUCTURE_LOAD_ERROR_MESSAGE

public static final String STRUCTURE_LOAD_ERROR_MESSAGE

See Also:

Constant Field Values

TAB_SIZE

public static final int TAB_SIZE

See Also:

Constant Field Values

Constructor Detail

StructureEditorChip

public StructureEditorChip(DisplayState displayState,
                           Chip parent)

Constructor. Calls loadStructure().

Method Detail

processEvents

public void processEvents(Map events)

Description copied from interface: Chip

Handles all incoming requests for this chip. Map contains name (String) and value (List of Strings)

getJSPURI

public String getJSPURI()

Description copied from interface: Chip

Returns the URI of the JSP that this chip wants to use.

getStructure

public String getStructure()

Returns structure the chip currently holds. The structure can be set by setStructure() or loadStructure(). setStructure(String) loadStructure()

Returns:

structure as String

getStructureQuoted

public String getStructureQuoted()

Returns structure the chip currently holds, but with encoded HTML entities. getStructure()

Returns:

structure as String

loadStructureFromFile

public boolean loadStructureFromFile()

Loads structure from hmc.xml and stores it in this chip.

Returns:

true if loading was successful

setStructure

public void setStructure(String structure)

Sets structure the chip will be holding. Structure will not be saved in the databank (in can be done by saveStructure()).

Parameters:

structure - the structure saveStructure()

saveStructure

public void saveStructure()

Saves current structure in the database.

validateStructure

public boolean validateStructure(boolean saving)

Validates the current structure without saving or changing anything.

loadStructure

public void loadStructure()

Loads structure from the database and stores it in the chip. You can get the structure by calling getStructure(). getStructure()

getTitle

public String getTitle()

Returns title of this chip.

isUsingDBForStructure

public static boolean isUsingDBForStructure()

Returns true if the hmc is configured to load the hmc.xml from the database. (i.e. if the property hmc.structure.db is set to true)

getConfirmXSDMessage

public String getConfirmXSDMessage()

Returns a (localized) message if either the xsd url is not set or this url is not reachable/empty.

Returns:

error message according to missing or erroneous schema url or an empty string if the url is okay