com.hybris.cockpitng.renderers.header

Class DefaultWidgetCaptionWrapper

java.lang.Object

com.hybris.cockpitng.renderers.header.DefaultWidgetCaptionWrapper

All Implemented Interfaces:

WidgetCaptionWrapper

public class DefaultWidgetCaptionWrapper
extends Object
implements WidgetCaptionWrapper

Default implementation of WidgetCaptionWrapper.

Field Summary

Fields inherited from interface com.hybris.cockpitng.renderers.header.WidgetCaptionWrapper

CONTROL_CLOSE, CONTROL_COLLAPSE, CONTROL_MAXIMIZE, CONTROL_MINIMIZE, ON_CONTROL_STATE_CHANGE, ON_WIDGET_CLOSE, ON_WIDGET_COLLAPSE, ON_WIDGET_FOCUS, ON_WIDGET_MAXIMIZE, ON_WIDGET_MINIMIZE, ON_WIDGET_SIZE

Constructor Summary

Constructors

Constructor and Description
DefaultWidgetCaptionWrapper(WidgetCaptionEventListener containerListener, boolean focused, boolean minimized, boolean maximized, boolean collapsed)

Method Summary

Modifier and Type	Method and Description
void	addListener(String eventName, WidgetCaptionEventListener eventListener)
void	close() Closes the container (this usually means that the related widget instance is removed).
int	getHiddenContainerControls()
void	hideContainerControls(int controls) Call this in your renderer method to hide standard controls from the container, e.g.
boolean	isClosable() Returns true if the current state of the container allows closing.
boolean	isCollapsed() Returns true if the caption indicates that the container is collapsed.
boolean	isCollapsible() Returns true if the current state of the container allows collapsing.
boolean	isFocused() Returns true if the caption indicates that the container is focused/selected.
boolean	isMaximizable() Returns true if the current state of the container allows maximizing.
boolean	isMaximized() Returns true if the caption indicates that the container is maximized.
boolean	isMinimizable() Returns true if the current state of the container allows minimizing.
boolean	isMinimized() Returns true if the caption indicates that the container is minimized.
protected void	notifyContainerListener(String eventName)
void	sendEvent(String eventName, boolean state)
void	setClosable(boolean closable)
void	setCollapsed(boolean collapsed) Expands or collapses the container according to the argument.
void	setCollapsible(boolean collapsible)
void	setFocused(boolean focused) Sets the focus to (or selects) the current widget within it's widgetchildren container.
void	setMaximizable(boolean maximizable)
void	setMaximized(boolean maximized) Maximizes/unmaximizes the container according to the argument.
void	setMinimizable(boolean minimizable)
void	setMinimized(boolean minimized) Minimizes/unminimizes the container according to the argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWidgetCaptionWrapper

public DefaultWidgetCaptionWrapper(WidgetCaptionEventListener containerListener,
                                   boolean focused,
                                   boolean minimized,
                                   boolean maximized,
                                   boolean collapsed)

Method Detail

hideContainerControls

public void hideContainerControls(int controls)

Description copied from interface: WidgetCaptionWrapper

Call this in your renderer method to hide standard controls from the container, e.g. if you want to render buttons to control minimizing and maximizing of the widget and thus don't need the minimize/maximize buttons of a window/panel/... you could use

hideContainerControls(WidgetCaptionWrapper.CONTROL_MINIMIZE | WidgetCaptionWrapper.CONTROL_MAXIMIZE)

Specified by:

hideContainerControls in interface WidgetCaptionWrapper

getHiddenContainerControls

public int getHiddenContainerControls()

sendEvent

public void sendEvent(String eventName,
                      boolean state)

addListener

public void addListener(String eventName,
                        WidgetCaptionEventListener eventListener)

Specified by:

addListener in interface WidgetCaptionWrapper

eventListener - a listener to be notified when an operation happens

isMinimized

public boolean isMinimized()

Description copied from interface: WidgetCaptionWrapper

Returns true if the caption indicates that the container is minimized.

Specified by:

isMinimized in interface WidgetCaptionWrapper

isMaximized

public boolean isMaximized()

Description copied from interface: WidgetCaptionWrapper

Returns true if the caption indicates that the container is maximized.

Specified by:

isMaximized in interface WidgetCaptionWrapper

isFocused

public boolean isFocused()

Description copied from interface: WidgetCaptionWrapper

Returns true if the caption indicates that the container is focused/selected.

Specified by:

isFocused in interface WidgetCaptionWrapper

isCollapsed

public boolean isCollapsed()

Description copied from interface: WidgetCaptionWrapper

Returns true if the caption indicates that the container is collapsed.

Specified by:

isCollapsed in interface WidgetCaptionWrapper

notifyContainerListener

protected void notifyContainerListener(String eventName)

setMinimized

public void setMinimized(boolean minimized)

Description copied from interface: WidgetCaptionWrapper

Minimizes/unminimizes the container according to the argument.

Specified by:

setMinimized in interface WidgetCaptionWrapper

setMaximized

public void setMaximized(boolean maximized)

Description copied from interface: WidgetCaptionWrapper

Maximizes/unmaximizes the container according to the argument.

Specified by:

setMaximized in interface WidgetCaptionWrapper

setFocused

public void setFocused(boolean focused)

Description copied from interface: WidgetCaptionWrapper

Sets the focus to (or selects) the current widget within it's widgetchildren container.

Specified by:

setFocused in interface WidgetCaptionWrapper

setCollapsed

public void setCollapsed(boolean collapsed)

Description copied from interface: WidgetCaptionWrapper

Expands or collapses the container according to the argument.

Specified by:

setCollapsed in interface WidgetCaptionWrapper

close

public void close()

Description copied from interface: WidgetCaptionWrapper

Closes the container (this usually means that the related widget instance is removed).

Specified by:

close in interface WidgetCaptionWrapper

isMaximizable

public boolean isMaximizable()

Description copied from interface: WidgetCaptionWrapper

Returns true if the current state of the container allows maximizing.

Specified by:

isMaximizable in interface WidgetCaptionWrapper

isMinimizable

public boolean isMinimizable()

Description copied from interface: WidgetCaptionWrapper

Returns true if the current state of the container allows minimizing.

Specified by:

isMinimizable in interface WidgetCaptionWrapper

isClosable

public boolean isClosable()

Description copied from interface: WidgetCaptionWrapper

Returns true if the current state of the container allows closing.

Specified by:

isClosable in interface WidgetCaptionWrapper

isCollapsible

public boolean isCollapsible()

Description copied from interface: WidgetCaptionWrapper

Returns true if the current state of the container allows collapsing.

Specified by:

isCollapsible in interface WidgetCaptionWrapper

setMaximizable

public void setMaximizable(boolean maximizable)

setMinimizable

public void setMinimizable(boolean minimizable)

setClosable

public void setClosable(boolean closable)

setCollapsible

public void setCollapsible(boolean collapsible)