org.jowidgets.api.widgets

Interface IComponent

All Superinterfaces:

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

All Known Subinterfaces:

IButton, ICalendar, ICanvas, ICheckBox, IComboBox<VALUE_TYPE>, IComposite, IContainer, IControl, IDynamicFlowLayoutComposite, IExpandComposite, IFrame, IIcon, IInputComponent<VALUE_TYPE>, IInputComponentValidationLabel, IInputComposite<INPUT_TYPE>, IInputContentContainer, IInputControl<VALUE_TYPE>, IInputDialog<INPUT_TYPE>, IInputField<VALUE_TYPE>, ILabel, ILevelMeter, IMessageDialog, IPasswordChangeDialog, IPopupDialog, IProgressBar, IQuestionDialog, IScrollComposite, ISlider, ISliderViewer<VALUE_TYPE>, ISplitComposite, ITabFolder, ITabItem, ITable, ITextArea, ITextControl, ITextLabel, IToggleButton, IToolBar, IToolBarContainerItem, ITree, ITreeViewer<ROOT_NODE_VALUE_TYPE>, IUnitValueField<BASE_VALUE_TYPE,UNIT_VALUE_TYPE>, IValidationResultLabel, IWindow

All Known Implementing Classes:

AbstractCompositeInputControl, AbstractInputControl, AbstractTableCellEditor, ButtonWrapper, CheckBoxWrapper, ComboBoxWrapper, ComponentWrapper, CompositeControl, CompositeWrapper, ContainerWrapper, ControlWrapper, Dialog, Frame, FrameWrapper, InputControlWrapper, InputDialogWrapper, JoButton, JoCheckBox, JoComboBox, JoComboBoxSelection, JoComposite, JoContainer, JoDialog, JoFrame, JoIcon, JoInputField, JoLabel, JoMessageDialog, JoProgressBar, JoQuestionDialog, JoScrollComposite, JoSplitComposite, JoTextLabel, JoToggleButton, TabFolderWrapper, TableWrapper, TreeWrapper, WindowWrapper

public interface IComponent
extends IWidget, IComponentCommon, IShowingStateObservable

Method Summary

Methods

Modifier and Type	Method and Description
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
Rectangle	getBounds() Gets the bounds of the component
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.
void	setBounds(Rectangle bounds) The the bounds of the component
void	setPopupMenu(IMenuModel popupMenu) 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	setSize(int width, int height) Sets the size of the component defined by width and height
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 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.IComponentCommon

getBackgroundColor, getForegroundColor, getPosition, getSize, isVisible, redraw, requestFocus, setBackgroundColor, setCursor, setForegroundColor, setPosition, setRedrawEnabled, setSize, setVisible

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

getUiReference, isEnabled, setEnabled

Methods inherited from interface org.jowidgets.common.widgets.controller.IComponentObservable

addComponentListener, removeComponentListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IFocusObservable

addFocusListener, removeFocusListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IKeyObservable

addKeyListener, removeKeyListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseObservable

addMouseListener, removeMouseListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseMotionObservable

addMouseMotionListener, removeMouseMotionListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IPopupDetectionObservable

addPopupDetectionListener, removePopupDetectionListener

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

addShowingStateListener, removeShowingStateListener

Method Detail

isReparentable

boolean isReparentable()

Gets the information if the component is reparentable

Returns:

True if the component is reparentable, false otherwise

isShowing

boolean isShowing()

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

Returns:

True if the component is showing, false otherwise

hasFocus

boolean hasFocus()

Gets the input focus state of the component. Only one component can have the focus at the same time

Returns:

true if the component has the focus, false otherwise

createPopupMenu

IPopupMenu createPopupMenu()

Creates a popup menu as a child of this component

Returns:

The created popup menu, never null

setPopupMenu

void setPopupMenu(IMenuModel popupMenu)

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.

Parameters:

menuModel - The model of the popup menu or null, if no popup should be shown on popup events

toScreen

Position toScreen(Position localPosition)

Transforms a position in the coordinate system of this component to the screen coordinate system

Parameters:

localPosition - The local position, must not be null

Returns:

The corresponding screen position, never null

toLocal

Position toLocal(Position screenPosition)

Transforms a position in the screen coordinate system to this components coordinate system

Parameters:

screenPosition - The screen position to transform, must not ne null

Returns:

The corresponding local position, never null

setSize

void setSize(int width,
           int height)

Sets the size of the component defined by width and height

Parameters:

width - The width

height - The height

setPosition

void setPosition(int x,
               int y)

Sets the position of the component defined by the x-coordinate and the y-coordinate

Parameters:

x - The x coordinate

y - The y coordinate

getBounds

Rectangle getBounds()

Gets the bounds of the component

Returns:

The bounds, never null

setBounds

void setBounds(Rectangle bounds)

The the bounds of the component

Parameters:

bounds - The bounds to set, never null

fromComponent

Position fromComponent(IComponentCommon component,
                     Position componentPosition)

Transforms a position from another components coordinate system to this components coordinate system

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

Position toComponent(Position componentPosition,
                   IComponentCommon component)

Transforms a position from this components coordinate system to another components coordinate system

Parameters:

componentPosition - The position in this coordinate system

component - Component, in what coordinate system the position is transformed to

Returns:

The transformed position