de.hybris.platform.print.hmc

Class PrintHMCExtension

java.lang.Object

de.hybris.platform.hmc.extension.HMCExtension

de.hybris.platform.print.hmc.PrintHMCExtension

public class PrintHMCExtension
extends HMCExtension

Provides necessary meta information about the print hmc extension.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_PATH

Constructor Summary

Constructors

Constructor and Description
PrintHMCExtension()

Method Summary

Modifier and Type	Method and Description
ActionResult	beforeSave(Item item, DisplayState displayState, Map currentValues, Map initialValues) The maps currentValues and initialValues can be used to implement filtering of values, which must not be saved.
protected void	createCrossreferences(Item item, String attributeStringValue, String attributeStringQualifier, Language lang) Creates the Collection of Crossreference for the current Item, Attribute and language.
List	getEditorTabChips(DisplayState displayState, AbstractEditorMenuChip parent)
static String	getLocalizedString(String strKey, JaloSession jaloSession) Deprecated. use getLocalizedString(String strKey, SessionContext ctx) instead.
static String	getLocalizedString(String strKey, SessionContext ctx) Returns a localized string for the given key.
static String	getLocalizedString(String strKey, String isocode) Returns a localized string for the given key.
static ResourceBundle	getLocalizeResBundle(String isoCode) Returns the resource bundle for the given iso code.
ResourceBundle	getLocalizeResourceBundle(Locale locale) Should return the resource bundle for the extension and the given locale.
List	getMenuEntrySlotEntries(DisplayState displayState, Chip parent)
String	getResourcePath() Should return the path to the resource bundle.
List	getSectionChips(DisplayState displayState, ClipChip parent)
List	getToolbarActionChips(DisplayState displayState, Chip parent)
List	getTreeNodeChips(DisplayState displayState, Chip parent)
protected boolean	isStringValueType(AttributeDescriptor attributeDescriptor) Checks if given attribute is of String type or a Map of Strings

Methods inherited from class de.hybris.platform.hmc.extension.HMCExtension

adjustEditorConfiguration, adjustToolbarActionChips, afterCreate, afterRemove, afterSave, afterSave, beforeCreate, beforeRemove, notifySessionBegin

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_PATH

public static final String RESOURCE_PATH

See Also:

Constant Field Values

Constructor Detail

PrintHMCExtension

public PrintHMCExtension()

Method Detail

getTreeNodeChips

public List getTreeNodeChips(DisplayState displayState,
                             Chip parent)

Specified by:

getTreeNodeChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent AbstractExplorerMenuTreeNodeChip

Returns:

List of AbstractExplorerMenuTreeNodeChips.

See Also:

HMCExtension.getTreeNodeChips(DisplayState, Chip)

getMenuEntrySlotEntries

public List getMenuEntrySlotEntries(DisplayState displayState,
                                    Chip parent)

Specified by:

getMenuEntrySlotEntries in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent Chip

Returns:

List of MenuEntrySlotEntry.

See Also:

HMCExtension.getMenuEntrySlotEntries(DisplayState, Chip)

getSectionChips

public List getSectionChips(DisplayState displayState,
                            ClipChip parent)

Specified by:

getSectionChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent ClipChip

Returns:

List of ClipChips.

See Also:

HMCExtension.getSectionChips(de.hybris.platform.hmc.webchips.DisplayState, de.hybris.platform.hmc.generic.ClipChip)

getEditorTabChips

public List getEditorTabChips(DisplayState displayState,
                              AbstractEditorMenuChip parent)

Specified by:

getEditorTabChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent AbstractEditorMenuChip

Returns:

List of EditorTabChip

getToolbarActionChips

public List getToolbarActionChips(DisplayState displayState,
                                  Chip parent)

Specified by:

getToolbarActionChips in class HMCExtension

Parameters:

displayState - the current DisplayState

parent - the parent Chip

Returns:

List of ToolbarActionChips.

See Also:

HMCExtension.getToolbarActionChips(de.hybris.platform.hmc.webchips.DisplayState, de.hybris.platform.hmc.webchips.Chip)

getLocalizeResBundle

public static ResourceBundle getLocalizeResBundle(String isoCode)
                                           throws MissingResourceException

Returns the resource bundle for the given iso code. Uses BUNDLEPATH to locate the resource bundle.

Parameters:

isoCode - the resource bundle iso code.

Returns:

ResourceBundle the resource bundle

Throws:

MissingResourceException - if the resource bundle is missing at the given path

getLocalizedString

public static String getLocalizedString(String strKey,
                                        String isocode)

Returns a localized string for the given key. If the key doesn't exists the key itself will be returned.

Parameters:

strKey - the localized string key

isocode - the language iso code.

getLocalizedString

public static String getLocalizedString(String strKey,
                                        SessionContext ctx)

Returns a localized string for the given key. If the key doesn't exists the key itself will be returned.

Parameters:

strKey - the localized string key.

ctx - the current session context. will be used to compute the isocode of the session context language.

getLocalizedString

@Deprecated
public static String getLocalizedString(String strKey,
                                                    JaloSession jaloSession)

Deprecated. use getLocalizedString(String strKey, SessionContext ctx) instead.

Returns a localized string for the given key.

getLocalizeResourceBundle

public ResourceBundle getLocalizeResourceBundle(Locale locale)

Description copied from class: HMCExtension

Should return the resource bundle for the extension and the given locale. If there is no resource bundle, i.e because there are no special messages used this method should throw a MissingResourceException.

Specified by:

getLocalizeResourceBundle in class HMCExtension

Returns:

The resource bundle containing the localized strings and their values for the given locale. Cannot be NULL.

getResourcePath

public String getResourcePath()

Description copied from class: HMCExtension

Should return the path to the resource bundle.

Specified by:

getResourcePath in class HMCExtension

Returns:

The path of the resource bundle containing the localized strings and their values.

beforeSave

public ActionResult beforeSave(Item item,
                               DisplayState displayState,
                               Map currentValues,
                               Map initialValues)

Description copied from class: HMCExtension

The maps currentValues and initialValues can be used to implement filtering of values, which must not be saved.

Overrides:

beforeSave in class HMCExtension

Parameters:

item - Item which attributes should be saved.

displayState - DisplayState

currentValues - Map containing all current attribute values. (Mapping: AttributeQualifier -> Value) Note: AttributeQualifier should always be treated caseinsensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other caseinsensitive implementations.

initialValues - Map containing all initial attribute values. (Mapping: AttributeQualifier -> Value) Note: AttributeQualifier should always be treated caseinsensitive. Use de.hybris.platform.util.collections.CaseInsensitiveMap or other caseinsensitive implementations.

Returns:

ActionResult with processing informations ( action processed successful etc )

isStringValueType

protected boolean isStringValueType(AttributeDescriptor attributeDescriptor)

Checks if given attribute is of String type or a Map of Strings

Parameters:

attributeDescriptor - is the attribute descriptor

createCrossreferences

protected void createCrossreferences(Item item,
                                     String attributeStringValue,
                                     String attributeStringQualifier,
                                     Language lang)

Creates the Collection of Crossreference for the current Item, Attribute and language.

Parameters:

item - crossreference source (e.g text attribute)

attributeStringValue - value of the attribute containing Links

attributeStringQualifier - attributes qualifier

lang - language for the qualifier - null if attribute is not localized