GxSidebar

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public class GxSidebar
```
The class manages the grid sidebar and its toolpanels

See Also:
[]

Field Summary

Fields
Modifier and Type	Field and Description
`BBjString`	`DefaultToolpanel$` The id of the default panel
`BBjNumber`	`HiddenByDefault!` When true, the sidebar will be hidden on the first draw, visible otherwise. default is false
`LinkedHashMap`	`Toolpanels!` A map for the registered toolpanels

Constructor Summary
Constructors
Constructor and Description
GxSidebar(BBjGridExWidget widget!)
Construct new sidebar

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`closeToolpanel(BBjString id!)` Close toolpanel Close the given toolpanel
`JsonObject`	`getAsJsonObject()` Convert the sidebar into json object
`void`	`openToolpanel(BBjString id!)` Open toolpanel Open the given toolpanel
`void`	`setVisible(BBjNumber visible!)` Set Visible Enable / Disable the grid sidebar

- Field Detail
  - DefaultToolpanel$
```
public BBjString DefaultToolpanel$
```
    The id of the default panel
  - HiddenByDefault!
```
public BBjNumber HiddenByDefault!
```
    When true, the sidebar will be hidden on the first draw, visible otherwise. default is false
  - Toolpanels!
```
public LinkedHashMap Toolpanels!
```
    A map for the registered toolpanels
- Constructor Detail
  - GxSidebar
```
public GxSidebar(BBjGridExWidget widget!)
```
    Construct new sidebar
    
    Parameters:
    BBjGridExWidget widget!
- Method Detail
  - closeToolpanel
```
public void closeToolpanel(BBjString id!)
```
    Close toolpanel
    
    Close the given toolpanel
    
    Parameters:
    BBjString id$ the toolpanel id
  - getAsJsonObject
```
public JsonObject getAsJsonObject()
```
    Convert the sidebar into json object
  - openToolpanel
```
public void openToolpanel(BBjString id!)
```
    Open toolpanel
    
    Open the given toolpanel
    
    Parameters:
    BBjString id$ the toolpanel id
  - setVisible
```
public void setVisible(BBjNumber visible!)
```
    Set Visible
    
    Enable / Disable the grid sidebar