ComponentWidget (Visual Library API)

java.lang.Object
- org.netbeans.api.visual.widget.Widget
- - org.netbeans.api.visual.widget.ComponentWidget

```
public class ComponentWidget
extends Widget
```
This widget allows to use an AWT/Swing component in the scene. The widget itself just represents and reserve the place occupied by the component. When a component is resized, then reserved place is recalculated. The component placement is automatically update based on the placement of the widget. The widget also paints the component in the satelite views.
When a widget is added into the scene, it has to attach a scene listener for automatic recalculation. The attaching is done automatically for the first time.

Nested Class Summary
- Nested classes/interfaces inherited from class org.netbeans.api.visual.widget.Widget
  Widget.Dependency

Constructor Summary

Constructors
Constructor Description

ComponentWidget(Scene scene, java.awt.Component component)
Creates a component widget.

Constructors
Constructor	Description
`ComponentWidget(Scene scene, java.awt.Component component)`	Creates a component widget.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.awt.Rectangle`	`calculateClientArea()`	Calculates a client area from the preferred size of the component.
`java.awt.Component`	`getComponent()`	Returns a AWT/Swing component.
`boolean`	`isComponentVisible()`	Returns whether the component should be visible.
`protected void`	`notifyAdded()`	This method is called to notify that the view is shown.
`protected void`	`notifyRemoved()`	This method is called to notify that the view is hidden.
`protected void`	`paintWidget()`	Paints the component widget.
`void`	`setComponentVisible(boolean componentVisible)`	Sets whether the component should be visible.

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

Methods inherited from class org.netbeans.api.visual.widget.Widget
addChild, addChild, addChild, addChild, addChildren, addDependency, bringToBack, bringToFront, convertLocalToScene, convertLocalToScene, convertSceneToLocal, convertSceneToLocal, createActions, equals, getAccessibleContext, getActions, getActions, getBackground, getBorder, getBounds, getChildConstraint, getChildren, getClientArea, getCursor, getCursorAt, getDependencies, getFont, getForeground, getGraphics, getLayout, getLocation, getLookup, getMaximumSize, getMinimumSize, getParentWidget, getPreferredBounds, getPreferredLocation, getPreferredSize, getResourceTable, getScene, getState, getToolTipText, hashCode, isCheckClipping, isEnabled, isHitAt, isOpaque, isPreferredBoundsSet, isRepaintRequiredForRevalidating, isValidated, isVisible, notifyBackgroundChanged, notifyFontChanged, notifyForegroundChanged, notifyStateChanged, paint, paintBackground, paintBorder, paintChildren, removeChild, removeChildren, removeChildren, removeDependency, removeFromParent, repaint, resolveBounds, revalidate, revalidate, setAccessibleContext, setBackground, setBackgroundFromResource, setBorder, setBorder, setCheckClipping, setChildConstraint, setCursor, setEnabled, setFont, setFontFromResource, setForeground, setForegroundFromResource, setLayout, setMaximumSize, setMinimumSize, setOpaque, setPreferredBounds, setPreferredLocation, setPreferredSize, setResourceTable, setState, setToolTipText, setVisible, updateResources

- Constructor Detail
  - ComponentWidget
```
public ComponentWidget(Scene scene,
                       java.awt.Component component)
```
    Creates a component widget.
    
    Parameters:
    
    scene - the scene
    
    component - the AWT/Swing component
- Method Detail
  - getComponent
```
public final java.awt.Component getComponent()
```
    Returns a AWT/Swing component.
    
    Returns:
    
    the AWT/Swing component
  - isComponentVisible
```
public final boolean isComponentVisible()
```
    Returns whether the component should be visible.
    
    Returns:
    
    true if the component is visible
  - setComponentVisible
```
public final void setComponentVisible(boolean componentVisible)
```
    Sets whether the component should be visible.
    
    Parameters:
    
    componentVisible - if true, then the component is visible
  - notifyAdded
```
protected final void notifyAdded()
```
    Description copied from class: Widget
    
    This method is called to notify that the view is shown. Note: You must not modify a tree of widgets from within this method. It means: do not call addChild, removeChild and similar methods.
    
    Overrides:
    
    notifyAdded in class Widget
  - notifyRemoved
```
protected final void notifyRemoved()
```
    Description copied from class: Widget
    
    This method is called to notify that the view is hidden. Note: You must not modify a tree of widgets from within this method. It means: do not call addChild, removeChild and similar methods.
    
    Overrides:
    
    notifyRemoved in class Widget
  - calculateClientArea
```
protected final java.awt.Rectangle calculateClientArea()
```
    Calculates a client area from the preferred size of the component.
    
    Overrides:
    
    calculateClientArea in class Widget
    
    Returns:
    
    the calculated client area
  - paintWidget
```
protected final void paintWidget()
```
    Paints the component widget.
    
    Overrides:
    
    paintWidget in class Widget

Class ComponentWidget

Nested Class Summary

Nested classes/interfaces inherited from class org.netbeans.api.visual.widget.Widget

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.netbeans.api.visual.widget.Widget

Constructor Detail

ComponentWidget

Method Detail

getComponent

isComponentVisible

setComponentVisible

notifyAdded

notifyRemoved

calculateClientArea

paintWidget