de.hybris.platform.hmc.webchips

Interface Chip

All Superinterfaces:

Cloneable, Serializable

All Known Subinterfaces:

ActionDialogChip, ClipChip, ComposedChip, DialogChip, EventCheckingChip, MenuTabContainerChip, NamedChip, SpecialEditor, SpecialParamEditor, SpecialReloadChip, SpecialSaveChip, StreamAcceptor, TabChip, ToolbarProvider, TypedChip

All Known Implementing Classes:

AbstractActionChip, AbstractActionDialogChip, AbstractAttributeDisplayChip, AbstractAttributeEditorChip, AbstractAttributeValueChip, AbstractAutocompleterToolbarActionChip, AbstractChip, AbstractClassificationAttributeEditorChip, AbstractDialogChip, AbstractEditorMenuChip, AbstractExplorerMenuTreeNodeChip, AbstractGenericConditionalSearchChip, AbstractGenericConditionalSearchToolbarChip, AbstractItemListEntryChip, AbstractItemTreeNodeChip, AbstractLuceneSearchChip, AbstractNumberDisplayChip, AbstractOnDemandPricesEditorChip, AbstractOrganizerChip, AbstractSelectToolbarActionChip, AbstractTabChip, AbstractToolbarActionChip, AbstractToolbarChip, AbstractTreeNodeChip, ActionDialogContainerChip, ActionResultChip, ActionSelectChip, AdvanceBooleanEditorChip, AdvancedBooleanDisplayChip, AllInstancesSelectEditorChip, AttributeChip, AttributeConfigurationCreatorChip, AttributeConfigurationCreatorChip.AttributSelectorChip, AttributeDescriptor2BooleanMapEditorChip, AttributeDescriptorSelectEditorChip, AttributeDescriptorsTreeNodeChip, AttributeDescriptorTreeLeafChip, AttributeSelectToolbarActionChip, AutocompleteReferenceEditorChip, AutomatedWorkflowActionTemplateClassEditorChip, BigDecimalDisplayChip, BigDecimalEditorChip, Blank, BooleanClassificationAttributeEditorChip, BooleanDisplayChip, BooleanEditorChip, ByteDisplayChip, ByteEditorChip, CatalogContentChip, CatalogToolbarActionChip, CatalogTreeLeafChip, CharacterEditorChip, ClassificationAttributeChip, ClassificationAttributeSelectToolbarActionChip, ClassificationAutocompleterToolbarChip, ClassificationConditionChip, ClassificationEditorChip, ClassificationImportTreeLeaf, ClassificationOrganizerListChip, ClassificationOrganizerSearchChip, ClassificationVariantListChip, ClassificationVariantListEditorChip, ClassificationVariantListEntryChip, CollectionDisplayChip, CollectionTreeViewChip, ComposedTypeTreeNodeChip, ContentBlockPreviewChip, ContentBlockWysiwygEditorChip, CreateItemListEntryChip, CreateNewToolbarActionChip, CreditCardNumberDisplayChip, CreditCardNumberEditorChip, CronJobContentChip, CronJobTreeLeafChip, CustomChip, DateClassificationAttributeEditorChip, DateDisplayChip, DateEditorChip, DateOnlyDateRangeEditorChip, DateRangeDisplayChip, DateRangeEditorChip, DateTimeDisplayChip, DateTimeEditorChip, DefaultContent, DefaultFooterChip, DefaultToolbarChip, DefaultTreeCellDisplayChip, DefaultValueEditorChip, DialogContainerChip, DiffTextDisplayChip, DirectoryTreeLeafChip, DirectoryViewChip, DiscountValueDisplayChip, DiscountValueEditorChip, DividerToolbarChip, DocumentEditorChip, DoubleDisplayChip, DoubleEditorChip, DownloadMediaEditorChip, DownloadUrlChip, DraggableReferenceListEditorChip, DropDownToolbarActionChip, DuplicateCatalogItemViewCell, EClass400DEImportTreeLeaf, EClass410DEImportTreeLeaf, EClass410ENImportTreeLeaf, EClass410FRImportTreeLeaf, EClass500DEImportTreeLeaf, EClass500ENImportTreeLeaf, EClass500FRImportTreeLeaf, EClass510DEImportTreeLeaf, EClass510ENImportTreeLeaf, EClass510FRImportTreeLeaf, EditableItemListEntryChip, EditorTabChip, EncryptedPasswordEditorChip, EnumClassificationAttributeEditorChip, EnumerationValueDisplayChip, EnumerationValueSelectEditorChip, EnumerationValueUsageFinderChip, EnumerationValueUsageLeafChip, ETim20DETreeLeaf, ETim30DETreeLeaf, ExplorerChip, ExtendedFlexibleConditionChip, ExtendedGenericConditionChip, FacetSortProviderEditorChip, FieldValueProviderSelectEditorChip, FileDownloadChip, FileDownloadWindow, FlexibleConditionChip, FloatDisplayChip, FloatEditorChip, Frame, FrameSet, GenericAtomicTypeListChip, GenericColumnLayoutChip, GenericConditionalSearchChip, GenericConditionChip, GenericDefaultSectionChip, GenericEditableListEntryChip, GenericEditorMenuChip, GenericEssentialsEditorChip, GenericExplorerMenuTreeNodeChip, GenericExplorerMenuTreeNodeContentChip, GenericFlexibleSearchOrganizerSearchChip, GenericItemChip, GenericItemCreatorChip, GenericItemListChip, GenericItemListEntryChip, GenericItemSearchListChip, GenericLayoutChip, GenericLayoutEditorChip, GenericLeafNodeChip, GenericListChip, GenericListEditorChip, GenericListEntryChip, GenericListLayoutChip, GenericLocalizableConditionChip, GenericMapTypeListChip, GenericMapTypeListEntryChip, GenericReferenceEditorChip, GenericReferenceListEditorChip, GenericResortableItemListChip, GenericResortableListChip, GenericResortableListEditorChip, GenericResortableReferenceListEditorChip, GenericRowChip, GenericSearchChip, GenericSearchItemListToolbarChip, GenericSectionChip, GenericShortcutChip, GenericTabEditorChip, GenericTableChip, GenericTDChip, GenericTRChip, GenericTreeNodeChip, HolderChip, HTMLDisplayEditorChip, IconChip, IconViewChip, ImageToolbarActionChip, ImpExReferenceMultiSelectEditorChip, IndexerOperationEditorChip, InlineShortcutChip, IntegerDisplayChip, IntegerEditorChip, ItemActionChip, ItemChip, ItemCreateTypeSelectChip, ItemDisplayChip, ItemHistoryChip, ItemListChip, ItemTreeViewChip, JavaClassEditorChip, LanguageSelectToolbarActionChip, LDAPAccountBooleanEditorChip, LDAPDistinguishedNameStringEditorChip, LinkShortcutChip, ListChip, ListEntryChip, ListFillChip, ListNumberChip, ListOperationChip, ListSearchAndReplaceChip, LocaleSelectEditorChip, LocalizableAttributeChip, LocalizableAttributeSelectChip, LocalizableAttributeSelectChip.LanguageSelectEditorChip, LogOutChip, LongAsDateEditorChip, LongAsDateTimeEditorChip, LongDisplayChip, LongEditorChip, LucenesearchContentChip, LucenesearchToolbarActionChip, MainChip, MakeWorkflowDecision, MapTypeEditorChip, MediaDownloadUrlChip, MediaEditorChip, MediaFileUploadEditorChip, MenuChip, MenuTabChip, ModalGenericFlexibleSearchOrganizerSearchChip, ModalGenericItemSearchListChip, ModalGenericSearchChip, ModalImpExMediaFileUploadChip, ModalMediaFileUploadChip, NamedHolderChip, NoAccessAttributeChip, NoAccessAttributeDisplayChip, NoAccessAttributeEditorChip, NoAccessChip, NoAccessClassificationAttributeEditorChip, NumberClassificationAttributeEditorChip, NumberEditorChip, ObjectDisplayChip, ObjectEditorChip, OpenPrintcockpitTreeLeafChip, OrderEntryOnDemandPricesEditorChip, OrderOnDemandPricesEditorChip, OrderPromotionsTabChip, OrganizerChip, OrganizerComponentChip, OrganizerCreateChip, OrganizerCreatorClearToolbarActionChip, OrganizerCreatorOpenEditorToolbarActionChip, OrganizerCreatorSaveAndCopyToolbarActionChip, OrganizerCreatorToolbarChip, OrganizerEditorFooterChip, OrganizerItemChip, OrganizerItemCreatorChip, OrganizerListChip, OrganizerListEntryChip, OrganizerSearchChip, OrganizerSearchToolbarChip, OrganizerToolbarChip, PartOfReferenceEditorChip, PasswordEditorChip, PKDisplayChip, PKEditorChip, PlaceholderDisplayChip, PreviewContextDisplayChip, PrincipalAccessRightsEditorChip, PrintContainerChip, ProductComparisonChip, ProfiClass30DETreeLeaf, ProfiClass40DETreeLeaf, ProgressToolbarActionChip, QRCodeDeeplinkChip, RadioButtonEditorChip, ReferenceAttributeEditorChip, ReferenceMultiSelectEditorChip, RefreshIntervalToolbarActionChip, ResultTypeAttributesChip, SavedQuerySelectToolbarActionChip, SavedValueEntryEditorChip, SearchAllChip, SearchGroupChip, SearchListChip, SearchResultActionChip, SearchResultActionDialogChip, SearchResultChip, SearchResultListChip, SearchResultNavigationChip, SearchResultToolbarChip, SearchResultTreeChip, SearchResultTreeRootChip, SearchTab, SelectableAbstractItemTreeNodeChip, SelectionOfCollectionReferenceEditorChip, SelectionOfCollectionReferenceEditorChip.SelectionOfSelectReferenceEditorChip, SelectionOfReferenceEditorChip, SelectLayoutChip, SelectReferenceEditorChip, ShortDisplayChip, ShortEditorChip, SimpleMessageDialogChip, SimpleSelectLayoutChip, SimpleTreeCellDisplayChip, SimpleURLDialogChip, SmartSelectionOfReferenceEditorChip, SocketChip, SpecialShortcutChip, StaticContentChip, StaticContentLeafChip, StringClassificationAttributeEditorChip, StringDisplayChip, StringEditorChip, StringLayoutChip, StringSelectEditorChip, StringSelectToolbarActionChip, StructureEditorChip, StructureTreeNodeChip, StyleWysiwygEditorChip, SubTypeSelectEditorChip, TaxValueDisplayChip, TaxValueEditorChip, TextAreaEditorChip, TextAreaLayoutChip, TextboxToolbarActionChip, TextChip, TextLabelToolbarActionChip, TimePeriodDisplayChip, TimePeriodEditorChip, ToggleTooblbarActionChip, ToolbarActionChip, ToolbarChip, TranslatorConfigurationPreviewChip, TreeChip, TreeChip.TreeNodeChip, TreeLeafChip, TreeViewChip, TriggerTimeValuesEditorChip, TypeAccessRightsEditorChip, TypeAttributesChip, TypedTreeLeafChip, TypeExportContentChip, TypeExportTreeNodeChip, TypeSelectToolbarActionChip, Unspsc50TreeLeaf, UploadExportWizardMediaChip, UploadHeaderLibraryChip, UploadJobMediaChip, UploadToImpExMediaEditorChip, UploadToMediaEditorChip, UrlAsImageDisplayChip, ValidationModeSelectEditorChip, VariantAttributesEditorChip, VariantListEditorChip, VersionAwareLanguageReferenceListChip, VoucherCodeGeneratorChip, VoucherEditorChip, Window, WizardInfoTabChip, WizardStatusTabChip, WorkflowInboxTreeLeafChip, WorkflowMyTreeLeafChip, WorkflowOrganizerChip, WysiwygEditorChip, ZipEntryFromMediaEditorChip, ZipEntrySelectEditorChip, ZipFileDownloadChip, ZipFileDownloadWindow

public interface Chip
extends Cloneable, Serializable

Chip Interface. See AbstractChip for a partial implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISPLAY_EVENT
static String	FILTERED_PREFIX Use this prefix infront of your event id if you do not want the event values filtered.

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 sets the "valid" state
void	dispose() called when its display state is unbound from its http session.
String	getCommandID(String eventID)
String	getDisplayParameters() Parameters the chip needs to restore its current display status.
DisplayState	getDisplayState()
String	getEventID(String eventID)
String	getEventURL(String eventID, String value)
String	getEventValue(String eventID, String value) Chips that translate event values (i.e.
String	getID()
JaloSession	getJaloSession()
String	getJSPURI() Returns the URI of the JSP that this chip wants to use.
List<MenuEntry>	getMenuEntries()
Chip	getParent()
String	getUniqueName()
void	goFullScreen()
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()
void	processEvents(Map<String,List<String>> events) Handles all incoming requests for this chip.
String	registerUniqueName(String proposedName, Chip child)
void	removeEventListener(String topic, ChipEventListener listener)
void	render(PageContext context) Renders the chip (usually using a jsp)
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!!!

Field Detail

FILTERED_PREFIX

static final String FILTERED_PREFIX

Use this prefix infront of your event id if you do not want the event values filtered. Any events without this prefix will be filtered and html will be converted to text.

See Also:

Constant Field Values

DISPLAY_EVENT

static final String DISPLAY_EVENT

See Also:

Constant Field Values

Method Detail

getMenuEntries

List<MenuEntry> getMenuEntries()

getDisplayState

DisplayState getDisplayState()

getID

String getID()

getJaloSession

JaloSession getJaloSession()

render

void render(PageContext context)
     throws ServletException,
            IOException

Renders the chip (usually using a jsp)

Throws:

ServletException

IOException

checkValid

void checkValid()

Gives the chip the possibility to check if its objects are still valid sets the "valid" state

isValid

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()

Returns:

true if still valid false if not

processEvents

void processEvents(Map<String,List<String>> events)

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

getJSPURI

String getJSPURI()

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

goFullScreen

void goFullScreen()

leaveFullScreen

void leaveFullScreen()

getEventID

String getEventID(String eventID)

getCommandID

String getCommandID(String eventID)

getEventValue

String getEventValue(String eventID,
                     String value)

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

getEventURL

String getEventURL(String eventID,
                   String value)

getParent

Chip getParent()

registerUniqueName

String registerUniqueName(String proposedName,
                          Chip child)

getUniqueName

String getUniqueName()

translateFormFieldToEventName

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!!!

translateFormFieldToEventValue

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!!!

addEventListener

void addEventListener(String topic,
                      ChipEventListener listener)

removeEventListener

void removeEventListener(String topic,
                         ChipEventListener listener)

dispose

void dispose()

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

getDisplayParameters

String getDisplayParameters()

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.

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.