org.jowidgets.common.widgets

Interface IComponentCommon

All Superinterfaces:

IComponentObservable, IFocusObservable, IKeyObservable, IMouseMotionObservable, IMouseObservable, IPopupDetectionObservable, IWidgetCommon

All Known Subinterfaces:

IButton, IButtonCommon, ICalendar, ICalendarCommon, ICanvas, ICanvasCommon, ICheckBox, IComboBox<VALUE_TYPE>, IComponent, IComposite, ICompositeCommon, IContainer, IContainerCommon, IControl, IControlCommon, IDynamicFlowLayoutComposite, IExpandComposite, IFrame, IFrameCommon, IIcon, IIconCommon, IInputComponent<VALUE_TYPE>, IInputComponentCommon, IInputComponentValidationLabel, IInputComposite<INPUT_TYPE>, IInputContentContainer, IInputControl<VALUE_TYPE>, IInputControlCommon, IInputDialog<INPUT_TYPE>, IInputField<VALUE_TYPE>, ILabel, ILevelMeter, IMessageDialog, IPasswordChangeDialog, IPopupDialog, IPopupDialogCommon, IProgressBar, IProgressBarCommon, IQuestionDialog, IScrollComposite, IScrollCompositeCommon, ISlider, ISliderCommon, ISliderViewer<VALUE_TYPE>, ISplitComposite, ISplitCompositeCommon, ITabFolder, ITabFolderCommon, ITabItem, ITabItemCommon, ITable, ITableCellEditor, ITableCommon, ITextArea, ITextAreaCommon, ITextControl, ITextControlCommon, ITextLabel, ITextLabelCommon, IToggleButton, IToolBar, IToolBarCommon, IToolBarContainerItem, IToolBarContainerItemCommon, ITree, ITreeCommon, ITreeViewer<ROOT_NODE_VALUE_TYPE>, IUnitValueField<BASE_VALUE_TYPE,UNIT_VALUE_TYPE>, IValidationResultLabel, IWindow, IWindowCommon

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 IComponentCommon
extends IWidgetCommon, IComponentObservable, IFocusObservable, IKeyObservable, IMouseObservable, IMouseMotionObservable, IPopupDetectionObservable

Method Summary

Methods

Modifier and Type	Method and Description
IColorConstant	getBackgroundColor() Gets the background color
IColorConstant	getForegroundColor() Gets the foreground color
Position	getPosition() Gets the position of the component
Dimension	getSize() Gets the current size of the component.
boolean	isVisible() Gets the visibility state.
void	redraw() Marks the widget that a redraw is necessary
boolean	requestFocus() Try's to get the focus for the component.
void	setBackgroundColor(IColorConstant colorValue) Sets the background color.
void	setCursor(Cursor cursor) Sets the cursor
void	setForegroundColor(IColorConstant colorValue) Sets the foreground color.
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	setVisible(boolean visible) Sets the components visibility state.

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

Method Detail

redraw

void redraw()

Marks the widget that a redraw is necessary

setRedrawEnabled

void setRedrawEnabled(boolean enabled)

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

Parameters:

enabled - The enabled state

requestFocus

boolean requestFocus()

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.

Returns:

false if the request definitively fails, true if it may succeed.

setForegroundColor

void setForegroundColor(IColorConstant colorValue)

Sets the foreground color. If set to null, the default color is used.

Parameters:

colorValue - The color to set, may be null

setBackgroundColor

void setBackgroundColor(IColorConstant colorValue)

Sets the background color. If set to null, the default color is used.

Parameters:

colorValue - The color to set, may be null

getForegroundColor

IColorConstant getForegroundColor()

Gets the foreground color

Returns:

The foreground color or null if no specific color is set

getBackgroundColor

IColorConstant getBackgroundColor()

Gets the background color

Returns:

The background color or null if no specific color is set

setCursor

void setCursor(Cursor cursor)

Sets the cursor

Parameters:

cursor - The cursor to set

setVisible

void setVisible(boolean visible)

Sets the components visibility state.

Parameters:

visible - The visibility state to set

isVisible

boolean isVisible()

Gets the visibility state.

Returns:

The visibility state

getSize

Dimension getSize()

Gets the current size of the component.

Returns:

The size of the component, never null

setSize

void setSize(Dimension size)

Sets the size of the component.

Parameters:

size - The size to set, must not be null

getPosition

Position getPosition()

Gets the position of the component

Returns:

The position of the component, never null

setPosition

void setPosition(Position position)

Sets the position of the component

Parameters:

position - The position of the component, must not be null