Class DefaultActionRenderer<I,O>
- java.lang.Object
-
- com.hybris.cockpitng.actions.impl.DefaultActionRenderer<I,O>
-
- All Implemented Interfaces:
CockpitActionRenderer<I,O>
- Direct Known Subclasses:
AbstractStatefulActionRenderer,CreateActionRenderer,CreatePermissionActionRenderer,DragAndDropConfigActionRenderer,LogoAction,MessageActionRenderer,SplitLayoutChooserActionRenderer
public class DefaultActionRenderer<I,O> extends java.lang.Object implements CockpitActionRenderer<I,O>
Default renderer for cockpit action. Shows an icon (action icon uri) with tooltip text (action name).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static interfaceDefaultActionRenderer.DefaultActionRendererEventListener<T extends org.zkoss.zk.ui.event.Event>Marker interface for events created by action renderer.
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.StringLABEL_CONTAINER_SCLASSprotected java.lang.StringtooltipText
-
Constructor Summary
Constructors Constructor Description DefaultActionRenderer()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidaddEventListener(org.zkoss.zk.ui.Component container, org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event> eventListener)protected voidaddKeyboardSupport(org.zkoss.zk.ui.Component component, CockpitAction<I,O> cockpitAction, ActionContext<I> ctx, org.zkoss.zk.ui.event.EventListener onClickEventListener)protected java.lang.StringadjustUri(ActionContext<I> context, java.lang.String uri)protected booleancheckDataCompatibleWithDefinedInput(CockpitAction<I,O> action, ActionContext<I> context)protected org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event>createEventListener(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)protected java.lang.StringcreateYTestId(ActionContext<I> context)Creates a default ytestidprotected java.lang.StringextractIconDisabledUri(ActionContext<I> context)protected java.lang.StringextractIconHoverUri(ActionContext<I> context)protected java.lang.StringextractIconUri(ActionContext<I> context)protected org.zkoss.zk.ui.event.KeyEventextractKeyEvent(org.zkoss.zk.ui.event.Event event)Extracts KeyEvent from given event.protected org.zkoss.zk.ui.HtmlBasedComponentfindActionComponent(org.zkoss.zk.ui.Component component)protected org.zkoss.zk.ui.HtmlBasedComponentfindGroupComponent(org.zkoss.zk.ui.Component component)protected <C extends org.zkoss.zk.ui.Component>
CfindParentComponent(org.zkoss.zk.ui.Component component, java.lang.Class<C> clazz)protected java.lang.StringgetActionBodySclass(ActionContext<I> context)Creates a default sclassprotected java.lang.StringgetIconHoverUri(ActionContext<I> context, boolean canPerform)protected java.lang.StringgetIconUri(ActionContext<I> context, boolean canPerform)KeyboardSupportServicegetKeyboardSupportService()protected java.lang.StringgetLocalizedName(ActionContext<?> context)protected org.zkoss.zk.ui.HtmlBasedComponentgetOrCreateContainer(org.zkoss.zk.ui.Component parent)protected org.zkoss.zul.ImagegetOrCreateIcon(org.zkoss.zk.ui.Component container)Deprecated, for removal: This API element is subject to removal in a future version.since 1811.protected org.zkoss.zul.ImagegetOrCreateIcon(org.zkoss.zk.ui.Component container, ActionContext<I> ctx)protected org.zkoss.zul.LabelgetOrCreateLabel(org.zkoss.zk.ui.Component container)protected org.zkoss.zul.LabelgetOrCreateLabel(org.zkoss.zk.ui.Component container, ActionContext<I> ctx)java.lang.StringgetTooltipText()protected java.lang.StringgetToolTipWithCtrlKeysText(java.lang.String toolTipToDecorate, ActionContext<I> ctx)protected <T> TloadFromParentModel(ActionContext<?> context, java.lang.String key, java.lang.Class<T> _clazz)protected voidperform(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)protected voidperformWithConfirmationCheck(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)protected voidregisterHoverEventsOnContainer(org.zkoss.zk.ui.HtmlBasedComponent container, org.zkoss.zul.Image icon, boolean showIcon, java.lang.String iconUri, java.lang.String iconHoverUri)protected voidremoveEventListeners(org.zkoss.zk.ui.Component container, java.lang.String eventName)Removes all even listeners of a given type from the container if they are assignable from com.hybris.cockpitng.actions.impl.DefaultActionRenderer.DefaultActionRendererEventListener.protected voidremoveEventListeners(org.zkoss.zk.ui.Component container, java.lang.String eventName, java.lang.Class type)Removes all even listeners of a given type from the container if they are assignable from the given type.protected voidremoveIcon(org.zkoss.zk.ui.Component container)protected voidremoveLabel(org.zkoss.zk.ui.Component container)voidrender(org.zkoss.zk.ui.Component parent, CockpitAction<I,O> action, ActionContext<I> context, boolean updateMode, ActionListener<O> listener)voidsetTooltipText(java.lang.String tooltipText)protected voidstoreInParentModel(java.lang.Object value, ActionContext<?> context, java.lang.String key)protected voidtriggerFromKeyEvent(org.zkoss.zk.ui.event.KeyEvent keyEvent, CockpitAction<I,O> cockpitAction, ActionContext<I> ctx, org.zkoss.zk.ui.Component container, org.zkoss.zk.ui.event.EventListener onClickEventListener)
-
-
-
Field Detail
-
LABEL_CONTAINER_SCLASS
protected static final java.lang.String LABEL_CONTAINER_SCLASS
- See Also:
- Constant Field Values
-
tooltipText
protected java.lang.String tooltipText
-
-
Method Detail
-
render
public void render(org.zkoss.zk.ui.Component parent, CockpitAction<I,O> action, ActionContext<I> context, boolean updateMode, ActionListener<O> listener)- Specified by:
renderin interfaceCockpitActionRenderer<I,O>
-
checkDataCompatibleWithDefinedInput
protected boolean checkDataCompatibleWithDefinedInput(CockpitAction<I,O> action, ActionContext<I> context)
-
getTooltipText
public java.lang.String getTooltipText()
-
setTooltipText
public void setTooltipText(java.lang.String tooltipText)
-
registerHoverEventsOnContainer
protected void registerHoverEventsOnContainer(org.zkoss.zk.ui.HtmlBasedComponent container, org.zkoss.zul.Image icon, boolean showIcon, java.lang.String iconUri, java.lang.String iconHoverUri)
-
removeEventListeners
protected void removeEventListeners(org.zkoss.zk.ui.Component container, java.lang.String eventName)Removes all even listeners of a given type from the container if they are assignable from com.hybris.cockpitng.actions.impl.DefaultActionRenderer.DefaultActionRendererEventListener.- Parameters:
container- a component from which the listeners should be removedeventName- name of the event on which the listeners are registered- See Also:
DefaultActionRenderer.DefaultActionRendererEventListener
-
removeEventListeners
protected void removeEventListeners(org.zkoss.zk.ui.Component container, java.lang.String eventName, java.lang.Class type)Removes all even listeners of a given type from the container if they are assignable from the given type.- Parameters:
container- a component from which the listeners should be removedeventName- name of the event on which the listeners are registeredtype- type to which the target listeners should be assignable
-
createYTestId
protected java.lang.String createYTestId(ActionContext<I> context)
Creates a default ytestid- Returns:
- ytestid
-
getActionBodySclass
protected java.lang.String getActionBodySclass(ActionContext<I> context)
Creates a default sclass- Returns:
- default sclass
-
perform
protected void perform(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)
-
performWithConfirmationCheck
protected void performWithConfirmationCheck(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)
-
getOrCreateContainer
protected org.zkoss.zk.ui.HtmlBasedComponent getOrCreateContainer(org.zkoss.zk.ui.Component parent)
-
getOrCreateIcon
@Deprecated(since="1811", forRemoval=true) protected org.zkoss.zul.Image getOrCreateIcon(org.zkoss.zk.ui.Component container)Deprecated, for removal: This API element is subject to removal in a future version.since 1811. Please usegetOrCreateIcon(Component, ActionContext)instead.
-
getOrCreateIcon
protected org.zkoss.zul.Image getOrCreateIcon(org.zkoss.zk.ui.Component container, ActionContext<I> ctx)
-
removeIcon
protected void removeIcon(org.zkoss.zk.ui.Component container)
-
getOrCreateLabel
protected org.zkoss.zul.Label getOrCreateLabel(org.zkoss.zk.ui.Component container, ActionContext<I> ctx)
-
getOrCreateLabel
protected org.zkoss.zul.Label getOrCreateLabel(org.zkoss.zk.ui.Component container)
-
removeLabel
protected void removeLabel(org.zkoss.zk.ui.Component container)
-
addKeyboardSupport
protected void addKeyboardSupport(org.zkoss.zk.ui.Component component, CockpitAction<I,O> cockpitAction, ActionContext<I> ctx, org.zkoss.zk.ui.event.EventListener onClickEventListener)
-
getToolTipWithCtrlKeysText
protected java.lang.String getToolTipWithCtrlKeysText(java.lang.String toolTipToDecorate, ActionContext<I> ctx)
-
extractKeyEvent
protected org.zkoss.zk.ui.event.KeyEvent extractKeyEvent(org.zkoss.zk.ui.event.Event event)
Extracts KeyEvent from given event.- Parameters:
event- event to cast.- Returns:
- KeyEvent or null if given event is not KeyEvent nor Forward Event with origin KeyEvent
-
triggerFromKeyEvent
protected void triggerFromKeyEvent(org.zkoss.zk.ui.event.KeyEvent keyEvent, CockpitAction<I,O> cockpitAction, ActionContext<I> ctx, org.zkoss.zk.ui.Component container, org.zkoss.zk.ui.event.EventListener onClickEventListener)
-
createEventListener
protected org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event> createEventListener(CockpitAction<I,O> action, ActionContext<I> context, ActionListener<O> listener)
-
addEventListener
protected void addEventListener(org.zkoss.zk.ui.Component container, org.zkoss.zk.ui.event.EventListener<? extends org.zkoss.zk.ui.event.Event> eventListener)
-
getIconHoverUri
protected java.lang.String getIconHoverUri(ActionContext<I> context, boolean canPerform)
-
getIconUri
protected java.lang.String getIconUri(ActionContext<I> context, boolean canPerform)
-
extractIconUri
protected java.lang.String extractIconUri(ActionContext<I> context)
-
extractIconHoverUri
protected java.lang.String extractIconHoverUri(ActionContext<I> context)
-
extractIconDisabledUri
protected java.lang.String extractIconDisabledUri(ActionContext<I> context)
-
adjustUri
protected java.lang.String adjustUri(ActionContext<I> context, java.lang.String uri)
-
getLocalizedName
protected java.lang.String getLocalizedName(ActionContext<?> context)
-
storeInParentModel
protected void storeInParentModel(java.lang.Object value, ActionContext<?> context, java.lang.String key)
-
loadFromParentModel
protected <T> T loadFromParentModel(ActionContext<?> context, java.lang.String key, java.lang.Class<T> _clazz)
-
findParentComponent
protected <C extends org.zkoss.zk.ui.Component> C findParentComponent(org.zkoss.zk.ui.Component component, java.lang.Class<C> clazz)
-
findActionComponent
protected org.zkoss.zk.ui.HtmlBasedComponent findActionComponent(org.zkoss.zk.ui.Component component)
-
findGroupComponent
protected org.zkoss.zk.ui.HtmlBasedComponent findGroupComponent(org.zkoss.zk.ui.Component component)
-
getKeyboardSupportService
public KeyboardSupportService getKeyboardSupportService()
-
-