WidgetCaptionWrapper (cockpitng 18.08.0-RC7 API)

All Known Implementing Classes:

DefaultWidgetCaptionWrapper
```
public interface WidgetCaptionWrapper
```
Wrapper interface to mediate between caption of a widgetContainer and the contained widget.

See Also:

WidgetCaptionEventListener

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONTROL_CLOSE`
`static int`	`CONTROL_COLLAPSE`
`static int`	`CONTROL_MAXIMIZE`
`static int`	`CONTROL_MINIMIZE`
`static String`	`ON_CONTROL_STATE_CHANGE`
`static String`	`ON_WIDGET_CLOSE`
`static String`	`ON_WIDGET_COLLAPSE`
`static String`	`ON_WIDGET_FOCUS`
`static String`	`ON_WIDGET_MAXIMIZE`
`static String`	`ON_WIDGET_MINIMIZE`
`static String`	`ON_WIDGET_SIZE`

Method Summary

All Methods Instance Methods Abstract Methods
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).
`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.
`void`	`setCollapsed(boolean collapsed)` Expands or collapses the container according to the argument.
`void`	`setFocused(boolean focused)` Sets the focus to (or selects) the current widget within it's widgetchildren container.
`void`	`setMaximized(boolean maximized)` Maximizes/unmaximizes the container according to the argument.
`void`	`setMinimized(boolean minimized)` Minimizes/unminimizes the container according to the argument.

- Field Detail
  - ON_WIDGET_COLLAPSE
```
static final String ON_WIDGET_COLLAPSE
```
    See Also:
    
    Constant Field Values
  - ON_WIDGET_MINIMIZE
```
static final String ON_WIDGET_MINIMIZE
```
    See Also:
    
    Constant Field Values
  - ON_WIDGET_MAXIMIZE
```
static final String ON_WIDGET_MAXIMIZE
```
    See Also:
    
    Constant Field Values
  - ON_WIDGET_SIZE
```
static final String ON_WIDGET_SIZE
```
    See Also:
    
    Constant Field Values
  - ON_WIDGET_FOCUS
```
static final String ON_WIDGET_FOCUS
```
    See Also:
    
    Constant Field Values
  - ON_WIDGET_CLOSE
```
static final String ON_WIDGET_CLOSE
```
    See Also:
    
    Constant Field Values
  - ON_CONTROL_STATE_CHANGE
```
static final String ON_CONTROL_STATE_CHANGE
```
    See Also:
    
    Constant Field Values
  - CONTROL_CLOSE
```
static final int CONTROL_CLOSE
```
    See Also:
    
    Constant Field Values
  - CONTROL_COLLAPSE
```
static final int CONTROL_COLLAPSE
```
    See Also:
    
    Constant Field Values
  - CONTROL_MINIMIZE
```
static final int CONTROL_MINIMIZE
```
    See Also:
    
    Constant Field Values
  - CONTROL_MAXIMIZE
```
static final int CONTROL_MAXIMIZE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - isCollapsed
```
boolean isCollapsed()
```
    Returns true if the caption indicates that the container is collapsed.
  - setCollapsed
```
void setCollapsed(boolean collapsed)
```
    Expands or collapses the container according to the argument.
  - isMinimized
```
boolean isMinimized()
```
    Returns true if the caption indicates that the container is minimized.
  - setMinimized
```
void setMinimized(boolean minimized)
```
    Minimizes/unminimizes the container according to the argument.
  - isMaximized
```
boolean isMaximized()
```
    Returns true if the caption indicates that the container is maximized.
  - setMaximized
```
void setMaximized(boolean maximized)
```
    Maximizes/unmaximizes the container according to the argument.
  - isFocused
```
boolean isFocused()
```
    Returns true if the caption indicates that the container is focused/selected.
  - setFocused
```
void setFocused(boolean focused)
```
    Sets the focus to (or selects) the current widget within it's widgetchildren container.
  - close
```
void close()
```
    Closes the container (this usually means that the related widget instance is removed).
  - isCollapsible
```
boolean isCollapsible()
```
    Returns true if the current state of the container allows collapsing.
  - isMinimizable
```
boolean isMinimizable()
```
    Returns true if the current state of the container allows minimizing.
  - isMaximizable
```
boolean isMaximizable()
```
    Returns true if the current state of the container allows maximizing.
  - isClosable
```
boolean isClosable()
```
    Returns true if the current state of the container allows closing.
  - hideContainerControls
```
void hideContainerControls(int controls)
```
    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)
  - addListener
```
void addListener(String eventName,
                 WidgetCaptionEventListener eventListener)
```
    Parameters:
    
    eventListener - a listener to be notified when an operation happens

Interface WidgetCaptionWrapper

Field Summary

Method Summary

Field Detail

ON_WIDGET_COLLAPSE

ON_WIDGET_MINIMIZE

ON_WIDGET_MAXIMIZE

ON_WIDGET_SIZE

ON_WIDGET_FOCUS

ON_WIDGET_CLOSE

ON_CONTROL_STATE_CHANGE

CONTROL_CLOSE

CONTROL_COLLAPSE

CONTROL_MINIMIZE

CONTROL_MAXIMIZE

Method Detail

isCollapsed

setCollapsed

isMinimized

setMinimized

isMaximized

setMaximized

isFocused

setFocused

close

isCollapsible

isMinimizable

isMaximizable

isClosable

hideContainerControls

addListener