ComponentWrapper (Jowidgets API Specification)

java.lang.Object
- org.jowidgets.tools.widgets.wrapper.WidgetWrapper
- - org.jowidgets.tools.widgets.wrapper.ComponentWrapper

All Implemented Interfaces:

IDisposeObservable, IShowingStateObservable, IComponent, IWidget, IComponentObservable, IFocusObservable, IKeyObservable, IMouseMotionObservable, IMouseObservable, IPopupDetectionObservable, IComponentCommon, IWidgetCommon

Direct Known Subclasses:

ContainerWrapper, ControlWrapper, WindowWrapper
```
public class ComponentWrapper
extends WidgetWrapper
implements IComponent
```

Constructor Summary

Constructors
Constructor and Description

ComponentWrapper(IComponent widget)

Constructors
Constructor and Description
`ComponentWrapper(IComponent widget)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addComponentListener(IComponentListener componentListener)` Adds a component listener
`void`	`addFocusListener(IFocusListener listener)` Adds a focus listener
`void`	`addKeyListener(IKeyListener listener)` Adds a key listener
`void`	`addMouseListener(IMouseListener mouseListener)` Adds a mouse listener
`void`	`addMouseMotionListener(IMouseMotionListener listener)` Adds a mouse motion listener
`void`	`addPopupDetectionListener(IPopupDetectionListener listener)` Adds a popup detection listener
`void`	`addShowingStateListener(IShowingStateListener listener)` Adds a showing state listener
`IPopupMenu`	`createPopupMenu()` Creates a popup menu as a child of this component
`Position`	`fromComponent(IComponentCommon component, Position componentPosition)` Transforms a position from another components coordinate system to this components coordinate system
`IColorConstant`	`getBackgroundColor()` Gets the background color
`Rectangle`	`getBounds()` Gets the bounds of the component
`IColorConstant`	`getForegroundColor()` Gets the foreground color
`Position`	`getPosition()` Gets the position of the component
`Dimension`	`getSize()` Gets the current size of the component.
`protected IComponent`	`getWidget()`
`boolean`	`hasFocus()` Gets the input focus state of the component.
`boolean`	`isReparentable()` Gets the information if the component is reparentable
`boolean`	`isShowing()` A root component is showing if it is visible.
`boolean`	`isVisible()` Gets the visibility state.
`void`	`redraw()` Marks the widget that a redraw is necessary
`void`	`removeComponentListener(IComponentListener componentListener)` Removes a component listener
`void`	`removeFocusListener(IFocusListener listener)` Removes a focus listener
`void`	`removeKeyListener(IKeyListener listener)` Removes a key listener
`void`	`removeMouseListener(IMouseListener mouseListener)` Removes a mouse listener
`void`	`removeMouseMotionListener(IMouseMotionListener mouseListener)` Removes a mouse motion listener
`void`	`removePopupDetectionListener(IPopupDetectionListener listener)` Removes a popup detection listener
`void`	`removeShowingStateListener(IShowingStateListener listener)` Removes a showing state listener
`boolean`	`requestFocus()` Try's to get the focus for the component.
`void`	`setBackgroundColor(IColorConstant colorValue)` Sets the background color.
`void`	`setBounds(Rectangle bounds)` The the bounds of the component
`void`	`setCursor(Cursor cursor)` Sets the cursor
`void`	`setForegroundColor(IColorConstant colorValue)` Sets the foreground color.
`void`	`setPopupMenu(IMenuModel menuModel)` Sets a popup menu for this component defined by a model.
`void`	`setPosition(int x, int y)` Sets the position of the component defined by the x-coordinate and the y-coordinate
`void`	`setPosition(Position position)` Sets the position of the component
`void`	`setRedrawEnabled(boolean enabled)` Enables or disabled the redraw of a component and its children.
`void`	`setSize(Dimension size)` Sets the size of the component.
`void`	`setSize(int width, int height)` Sets the size of the component defined by width and height
`void`	`setVisible(boolean visible)` Sets the components visibility state.
`Position`	`toComponent(Position componentPosition, IComponentCommon component)` Transforms a position from this components coordinate system to another components coordinate system
`Position`	`toLocal(Position screenPosition)` Transforms a position in the screen coordinate system to this components coordinate system
`Position`	`toScreen(Position localPosition)` Transforms a position in the coordinate system of this component to the screen coordinate system

Methods inherited from class org.jowidgets.tools.widgets.wrapper.WidgetWrapper
addDisposeListener, dispose, getParent, getRoot, getUiReference, isDisposed, isEnabled, removeDisposeListener, setEnabled

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

Methods inherited from interface org.jowidgets.api.widgets.IWidget
dispose, getParent, getRoot, isDisposed

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable
addDisposeListener, removeDisposeListener

Methods inherited from interface org.jowidgets.common.widgets.IWidgetCommon
getUiReference, isEnabled, setEnabled

- Constructor Detail
  - ComponentWrapper
```
public ComponentWrapper(IComponent widget)
```
- Method Detail
  - getWidget
```
protected IComponent getWidget()
```
    Overrides:
    
    getWidget in class WidgetWrapper
  - redraw
```
public void redraw()
```
    Description copied from interface: IComponentCommon
    
    Marks the widget that a redraw is necessary
    
    Specified by:
    
    redraw in interface IComponentCommon
  - setRedrawEnabled
```
public void setRedrawEnabled(boolean enabled)
```
    Description copied from interface: IComponentCommon
    
    Enables or disabled the redraw of a component and its children. If redraw is disabled, all changes of the component will not be made visible until redraw will be enabled again. REMARK: This is a hint and will not work for all platforms
    
    Specified by:
    
    setRedrawEnabled in interface IComponentCommon
    
    Parameters:
    enabled - The enabled state
  - setForegroundColor
```
public void setForegroundColor(IColorConstant colorValue)
```
    Description copied from interface: IComponentCommon
    
    Sets the foreground color. If set to null, the default color is used.
    
    Specified by:
    
    setForegroundColor in interface IComponentCommon
    
    Parameters:
    colorValue - The color to set, may be null
  - setBackgroundColor
```
public void setBackgroundColor(IColorConstant colorValue)
```
    Description copied from interface: IComponentCommon
    
    Sets the background color. If set to null, the default color is used.
    
    Specified by:
    
    setBackgroundColor in interface IComponentCommon
    
    Parameters:
    colorValue - The color to set, may be null
  - getForegroundColor
```
public IColorConstant getForegroundColor()
```
    Description copied from interface: IComponentCommon
    
    Gets the foreground color
    
    Specified by:
    
    getForegroundColor in interface IComponentCommon
    
    Returns:
    The foreground color or null if no specific color is set
  - getBackgroundColor
```
public IColorConstant getBackgroundColor()
```
    Description copied from interface: IComponentCommon
    
    Gets the background color
    
    Specified by:
    
    getBackgroundColor in interface IComponentCommon
    
    Returns:
    The background color or null if no specific color is set
  - setCursor
```
public void setCursor(Cursor cursor)
```
    Description copied from interface: IComponentCommon
    
    Sets the cursor
    
    Specified by:
    
    setCursor in interface IComponentCommon
    
    Parameters:
    cursor - The cursor to set
  - setVisible
```
public void setVisible(boolean visible)
```
    Description copied from interface: IComponentCommon
    
    Sets the components visibility state.
    
    Specified by:
    
    setVisible in interface IComponentCommon
    
    Parameters:
    visible - The visibility state to set
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: IComponentCommon
    
    Gets the visibility state.
    
    Specified by:
    
    isVisible in interface IComponentCommon
    
    Returns:
    The visibility state
  - isShowing
```
public boolean isShowing()
```
    Description copied from interface: IComponent
    
    A root component is showing if it is visible. A child component is showing if it is visible and if it's parent component is showing
    
    Specified by:
    
    isShowing in interface IComponent
    
    Returns:
    True if the component is showing, false otherwise
  - getSize
```
public Dimension getSize()
```
    Description copied from interface: IComponentCommon
    
    Gets the current size of the component.
    
    Specified by:
    
    getSize in interface IComponentCommon
    
    Returns:
    The size of the component, never null
  - setSize
```
public void setSize(Dimension size)
```
    Description copied from interface: IComponentCommon
    
    Sets the size of the component.
    
    Specified by:
    
    setSize in interface IComponentCommon
    
    Parameters:
    size - The size to set, must not be null
  - setSize
```
public void setSize(int width,
           int height)
```
    Description copied from interface: IComponent
    
    Sets the size of the component defined by width and height
    
    Specified by:
    
    setSize in interface IComponent
    
    Parameters:
    width - The width
    height - The height
  - setPosition
```
public void setPosition(int x,
               int y)
```
    Description copied from interface: IComponent
    
    Sets the position of the component defined by the x-coordinate and the y-coordinate
    
    Specified by:
    
    setPosition in interface IComponent
    
    Parameters:
    x - The x coordinate
    y - The y coordinate
  - getPosition
```
public Position getPosition()
```
    Description copied from interface: IComponentCommon
    
    Gets the position of the component
    
    Specified by:
    
    getPosition in interface IComponentCommon
    
    Returns:
    The position of the component, never null
  - setPosition
```
public void setPosition(Position position)
```
    Description copied from interface: IComponentCommon
    
    Sets the position of the component
    
    Specified by:
    
    setPosition in interface IComponentCommon
    
    Parameters:
    position - The position of the component, must not be null
  - getBounds
```
public Rectangle getBounds()
```
    Description copied from interface: IComponent
    
    Gets the bounds of the component
    
    Specified by:
    
    getBounds in interface IComponent
    
    Returns:
    The bounds, never null
  - setBounds
```
public void setBounds(Rectangle bounds)
```
    Description copied from interface: IComponent
    
    The the bounds of the component
    
    Specified by:
    
    setBounds in interface IComponent
    
    Parameters:
    bounds - The bounds to set, never null
  - toScreen
```
public Position toScreen(Position localPosition)
```
    Description copied from interface: IComponent
    
    Transforms a position in the coordinate system of this component to the screen coordinate system
    
    Specified by:
    
    toScreen in interface IComponent
    
    Parameters:
    localPosition - The local position, must not be null
    
    Returns:
    The corresponding screen position, never null
  - toLocal
```
public Position toLocal(Position screenPosition)
```
    Description copied from interface: IComponent
    
    Transforms a position in the screen coordinate system to this components coordinate system
    
    Specified by:
    
    toLocal in interface IComponent
    
    Parameters:
    screenPosition - The screen position to transform, must not ne null
    
    Returns:
    The corresponding local position, never null
  - fromComponent
```
public Position fromComponent(IComponentCommon component,
                     Position componentPosition)
```
    Description copied from interface: IComponent
    
    Transforms a position from another components coordinate system to this components coordinate system
    
    Specified by:
    
    fromComponent in interface IComponent
    
    Parameters:
    component - Component, which the position is relative to, must not be null
    componentPosition - Position The position to transform, must not be null
    
    Returns:
    The transformed position
  - toComponent
```
public Position toComponent(Position componentPosition,
                   IComponentCommon component)
```
    Description copied from interface: IComponent
    
    Transforms a position from this components coordinate system to another components coordinate system
    
    Specified by:
    
    toComponent in interface IComponent
    
    Parameters:
    componentPosition - The position in this coordinate system
    component - Component, in what coordinate system the position is transformed to
    
    Returns:
    The transformed position
  - isReparentable
```
public boolean isReparentable()
```
    Description copied from interface: IComponent
    
    Gets the information if the component is reparentable
    
    Specified by:
    
    isReparentable in interface IComponent
    
    Returns:
    True if the component is reparentable, false otherwise
  - requestFocus
```
public boolean requestFocus()
```
    Description copied from interface: IComponentCommon
    
    Try's to get the focus for the component. Remark: This is not always possible, so developers can not assume that requesting the focus guarantee's that the component gets the focus. Only if the focusGained event was fired, the component has the focus.
    
    Specified by:
    
    requestFocus in interface IComponentCommon
    
    Returns:
    false if the request definitively fails, true if it may succeed.
  - hasFocus
```
public boolean hasFocus()
```
    Description copied from interface: IComponent
    
    Gets the input focus state of the component. Only one component can have the focus at the same time
    
    Specified by:
    
    hasFocus in interface IComponent
    
    Returns:
    true if the component has the focus, false otherwise
  - addKeyListener
```
public void addKeyListener(IKeyListener listener)
```
    Description copied from interface: IKeyObservable
    
    Adds a key listener
    
    Specified by:
    
    addKeyListener in interface IKeyObservable
    
    Parameters:
    listener - The listener to add
  - removeKeyListener
```
public void removeKeyListener(IKeyListener listener)
```
    Description copied from interface: IKeyObservable
    
    Removes a key listener
    
    Specified by:
    
    removeKeyListener in interface IKeyObservable
    
    Parameters:
    listener - The listener to remove
  - addMouseListener
```
public void addMouseListener(IMouseListener mouseListener)
```
    Description copied from interface: IMouseObservable
    
    Adds a mouse listener
    
    Specified by:
    
    addMouseListener in interface IMouseObservable
    
    Parameters:
    mouseListener - The listener to add
  - removeMouseListener
```
public void removeMouseListener(IMouseListener mouseListener)
```
    Description copied from interface: IMouseObservable
    
    Removes a mouse listener
    
    Specified by:
    
    removeMouseListener in interface IMouseObservable
    
    Parameters:
    mouseListener - The listener to remove
  - addMouseMotionListener
```
public void addMouseMotionListener(IMouseMotionListener listener)
```
    Description copied from interface: IMouseMotionObservable
    
    Adds a mouse motion listener
    
    Specified by:
    
    addMouseMotionListener in interface IMouseMotionObservable
    
    Parameters:
    listener - The listener to add
  - removeMouseMotionListener
```
public void removeMouseMotionListener(IMouseMotionListener mouseListener)
```
    Description copied from interface: IMouseMotionObservable
    
    Removes a mouse motion listener
    
    Specified by:
    
    removeMouseMotionListener in interface IMouseMotionObservable
    
    Parameters:
    mouseListener - The listener to remove
  - addComponentListener
```
public void addComponentListener(IComponentListener componentListener)
```
    Description copied from interface: IComponentObservable
    
    Adds a component listener
    
    Specified by:
    
    addComponentListener in interface IComponentObservable
    
    Parameters:
    componentListener - The listener to add
  - removeComponentListener
```
public void removeComponentListener(IComponentListener componentListener)
```
    Description copied from interface: IComponentObservable
    
    Removes a component listener
    
    Specified by:
    
    removeComponentListener in interface IComponentObservable
    
    Parameters:
    componentListener - The listener to remove
  - addFocusListener
```
public void addFocusListener(IFocusListener listener)
```
    Description copied from interface: IFocusObservable
    
    Adds a focus listener
    
    Specified by:
    
    addFocusListener in interface IFocusObservable
    
    Parameters:
    listener - The listener to add
  - removeFocusListener
```
public void removeFocusListener(IFocusListener listener)
```
    Description copied from interface: IFocusObservable
    
    Removes a focus listener
    
    Specified by:
    
    removeFocusListener in interface IFocusObservable
    
    Parameters:
    listener - The listener to remove
  - addPopupDetectionListener
```
public void addPopupDetectionListener(IPopupDetectionListener listener)
```
    Description copied from interface: IPopupDetectionObservable
    
    Adds a popup detection listener
    
    Specified by:
    
    addPopupDetectionListener in interface IPopupDetectionObservable
    
    Parameters:
    listener - The listener to add
  - removePopupDetectionListener
```
public void removePopupDetectionListener(IPopupDetectionListener listener)
```
    Description copied from interface: IPopupDetectionObservable
    
    Removes a popup detection listener
    
    Specified by:
    
    removePopupDetectionListener in interface IPopupDetectionObservable
    
    Parameters:
    listener - The listener to remove
  - addShowingStateListener
```
public void addShowingStateListener(IShowingStateListener listener)
```
    Description copied from interface: IShowingStateObservable
    
    Adds a showing state listener
    
    Specified by:
    
    addShowingStateListener in interface IShowingStateObservable
    
    Parameters:
    listener - The listener to add
  - removeShowingStateListener
```
public void removeShowingStateListener(IShowingStateListener listener)
```
    Description copied from interface: IShowingStateObservable
    
    Removes a showing state listener
    
    Specified by:
    
    removeShowingStateListener in interface IShowingStateObservable
    
    Parameters:
    listener - The listener to remove
  - createPopupMenu
```
public IPopupMenu createPopupMenu()
```
    Description copied from interface: IComponent
    
    Creates a popup menu as a child of this component
    
    Specified by:
    
    createPopupMenu in interface IComponent
    
    Returns:
    The created popup menu, never null
  - setPopupMenu
```
public void setPopupMenu(IMenuModel menuModel)
```
    Description copied from interface: IComponent
    
    Sets a popup menu for this component defined by a model. The popup menu will be shown, when an popup event occurs on this component.
    
    Specified by:
    
    setPopupMenu in interface IComponent

Class ComponentWrapper

Constructor Summary

Method Summary

Methods inherited from class org.jowidgets.tools.widgets.wrapper.WidgetWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.jowidgets.api.widgets.IWidget

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable

Methods inherited from interface org.jowidgets.common.widgets.IWidgetCommon

Constructor Detail

ComponentWrapper

Method Detail

getWidget

redraw

setRedrawEnabled

setForegroundColor

setBackgroundColor

getForegroundColor

getBackgroundColor

setCursor

setVisible

isVisible

isShowing

getSize

setSize

setSize

setPosition

getPosition

setPosition

getBounds

setBounds

toScreen

toLocal

fromComponent

toComponent

isReparentable

requestFocus

hasFocus

addKeyListener

removeKeyListener

addMouseListener

removeMouseListener

addMouseMotionListener

removeMouseMotionListener

addComponentListener

removeComponentListener

addFocusListener

removeFocusListener

addPopupDetectionListener

removePopupDetectionListener

addShowingStateListener

removeShowingStateListener

createPopupMenu

setPopupMenu