ToggleActionBuilder

java.lang.Object
- docking.action.builder.AbstractActionBuilder<ToggleDockingAction,ActionContext,ToggleActionBuilder>
- - docking.action.builder.ToggleActionBuilder

public class ToggleActionBuilder
extends AbstractActionBuilder<ToggleDockingAction,ActionContext,ToggleActionBuilder>

Builder for ToggleDockingActions

Nested Class Summary
- Nested classes/interfaces inherited from class docking.action.builder.AbstractActionBuilder
  AbstractActionBuilder.When

Field Summary
- Fields inherited from class docking.action.builder.AbstractActionBuilder
  actionCallback, actionContextClass, keyBindingType, name, owner

Constructor Summary

Constructors
Constructor Description

ToggleActionBuilder(java.lang.String name, java.lang.String owner)
Builder constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ToggleDockingAction`	`build()`	Builds the action.
`ToggleActionBuilder`	`selected(boolean b)`	Configure the initial select state for the toggle action.
`protected ToggleActionBuilder`	`self()`	Returns this (typed for subclass) for chaining

Methods inherited from class docking.action.builder.AbstractActionBuilder
buildAndInstall, buildAndInstallLocal, decorateAction, description, enabled, enabledWhen, helpLocation, inWindow, isKeyBindingAction, isMenuAction, isPopupAction, isToolbarAction, keyBinding, keyBinding, menuGroup, menuGroup, menuIcon, menuMnemonic, menuPath, onAction, popupMenuGroup, popupMenuGroup, popupMenuIcon, popupMenuPath, popupWhen, sharedKeyBinding, supportsDefaultToolContext, toolBarGroup, toolBarGroup, toolBarIcon, toolBarIcon, validate, validContextWhen, withContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ToggleActionBuilder
```
public ToggleActionBuilder(java.lang.String name,
                           java.lang.String owner)
```
    Builder constructor
    
    Parameters:
    
    name - the name of the action to be built
    
    owner - the owner of the action to be build
- Method Detail
  - self
```
protected ToggleActionBuilder self()
```
    Description copied from class: AbstractActionBuilder
    
    Returns this (typed for subclass) for chaining
    
    Specified by:
    
    self in class AbstractActionBuilder<ToggleDockingAction,ActionContext,ToggleActionBuilder>
    
    Returns:
    
    this for chaining
  - build
```
public ToggleDockingAction build()
```
    Description copied from class: AbstractActionBuilder
    
    Builds the action. To build and install the action in one step, use AbstractActionBuilder.buildAndInstall(Tool) or AbstractActionBuilder.buildAndInstallLocal(ComponentProvider). AbstractActionBuilder.inWindow(When)
    
    Specified by:
    
    build in class AbstractActionBuilder<ToggleDockingAction,ActionContext,ToggleActionBuilder>
    
    Returns:
    
    the newly build action
  - selected
```
public ToggleActionBuilder selected(boolean b)
```
    Configure the initial select state for the toggle action.
    
    Parameters:
    
    b - the initial select state
    
    Returns:
    
    self Builder (for chaining)