|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Component
The top-level component interface which must be implemented by all UI components that use IT Mill Toolkit.
Nested Class Summary | |
---|---|
static class |
Component.ErrorEvent
Class of all component originated ErrorEvent s. |
static interface |
Component.ErrorListener
Listener interface for receiving Component.Errors s. |
static class |
Component.Event
Superclass of all component originated Event s. |
static interface |
Component.Focusable
Interface implemented by components which can obtain input focus. |
static interface |
Component.Listener
Listener interface for receiving Component.Event s. |
Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.Paintable |
---|
Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener |
Field Summary |
---|
Fields inherited from interface com.itmill.toolkit.terminal.Sizeable |
---|
SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
Method Summary | |
---|---|
void |
addListener(Component.Listener listener)
Registers a new component event listener for this component. |
void |
addStyleName(String style)
Adds style name to component. |
void |
attach()
Notifies the component that it is connected to an application. |
void |
childRequestedRepaint(Collection alreadyNotified)
The children must call this method when they need repainting. |
void |
detach()
Notifies the component that it is detached from the application. |
Application |
getApplication()
Gets the component's parent application. |
String |
getCaption()
Gets the caption of the component. |
Resource |
getIcon()
Gets the component's icon. |
Locale |
getLocale()
Gets the locale of this component. |
Component |
getParent()
Gets the visual parent of the component. |
String |
getStyleName()
Gets style for component. |
Window |
getWindow()
Gets the component's parent window. |
boolean |
isEnabled()
Tests if the component is enabled or not. |
boolean |
isReadOnly()
Tests if the component is in read-only mode. |
boolean |
isVisible()
Tests the components visibility. |
void |
removeListener(Component.Listener listener)
Removes a previously registered component event listener from this component. |
void |
removeStyleName(String style)
Removes given style name from component. |
void |
setCaption(String caption)
Sets the component's caption String . |
void |
setEnabled(boolean enabled)
Enables or disables the component. |
void |
setIcon(Resource icon)
Sets the component's icon. |
void |
setParent(Component parent)
Sets the component's parent component. |
void |
setReadOnly(boolean readOnly)
Sets the component's to read-only mode to the specified state. |
void |
setStyleName(String style)
Sets and replaces all previous style names of the component. |
void |
setVisible(boolean visible)
Sets this components visibility status. |
Methods inherited from interface com.itmill.toolkit.terminal.Paintable |
---|
addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId |
Methods inherited from interface com.itmill.toolkit.terminal.VariableOwner |
---|
changeVariables, isImmediate |
Methods inherited from interface com.itmill.toolkit.terminal.Sizeable |
---|
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidth, setWidthUnits |
Method Detail |
---|
String getStyleName()
void setStyleName(String style)
RepaintRequestEvent
.
style
- the new style of the component.void addStyleName(String style)
RepaintRequestEvent
.
style
- the new style to be added to the componentvoid removeStyleName(String style)
style
- the style to be removedboolean isEnabled()
Tests if the component is enabled or not. All the variable change events are blocked from disabled components. Also the component should visually indicate that it is disabled (by shading the component for example). All hidden (isVisible() == false) components must return false.
Note The component is considered disabled if it's parent is disabled.
Components should be enabled by default.
isEnabled
in interface VariableOwner
true
if the component, and it's parent, is enabled
false
otherwise.VariableOwner.isEnabled()
void setEnabled(boolean enabled)
RepaintRequestEvent
.
Note that after enabling a component, isEnabled()
might
still return false if the parent is disabled.
Also note that if the component contains child-components, it should recursively call requestRepaint() for all descendant components.
enabled
- the boolean value specifying if the component should be
enabled after the call or notboolean isVisible()
true
.
Note that to return true, this component and all its parents must be visible.
Also note that this method does not check if component is attached
and shown to user. Component and all its parents may be visible, but not
necessary attached to application. To test if component will be drawn,
check its visibility and that getApplication()
does not
return null
.
true
if the component is visible in the UI,
false
if notvoid setVisible(boolean visible)
Note that to be shown in UI this component and all its parents must be visible.
visible
- the boolean value specifying if the component should be
visible after the call or not.Component getParent()
void setParent(Component parent)
This method calls automatically attach()
if the parent is
attached to a window (or is itself a window}, and detach()
if
parent
is set null
, but the component was in
the application.
This method is rarely called directly. Instead the
ComponentContainer.addComponent(Component)
method is used to add
components to container, which call this method implicitly.
parent
- the new parent component.boolean isReadOnly()
true
if the component is in read-only mode,
false
if not.void setReadOnly(boolean readOnly)
RepaintRequestEvent
.
readOnly
- the boolean value specifying if the component should be in
read-only mode after the call or not.String getCaption()
String
.void setCaption(String caption)
String
. Caption is the visible
name of the component. This method will trigger a
RepaintRequestEvent
.
caption
- the new caption String
for the component.Resource getIcon()
null
if it not defined.void setIcon(Resource icon)
RepaintRequestEvent
.
icon
- the icon to be shown with the component's caption.Window getWindow()
null
is returned.
null
.Application getApplication()
null
is returned.
null
.void attach()
Notifies the component that it is connected to an application. This
method is always called before the component is first time painted and is
suitable to be extended. The getApplication
and
getWindow
methods might return null
before this
method is called.
The caller of this method is setParent(Component)
if the parent
is already in the application. If the parent is not in the application,
it must call the attach()
for all its children when it will be
added to the application.
void detach()
The getApplication()
and getWindow()
methods might
return null
after this method is called.
The caller of this method is setParent(Component)
if the parent
is in the application. When the parent is detached from the application
it is its response to call detach()
for all the children and to
detach itself from the terminal.
Locale getLocale()
Locale.getDefautlt
. Returns null if the component
does not have its own locale and has not yet been added to a
containment hierarchy such that the locale can be determined from
the containing parent.void childRequestedRepaint(Collection alreadyNotified)
alreadyNotified
- the collection of repaint request listeners that have been
already notified by the child. This component should not
renotify the listed listeners again. The container given as
parameter must be modifiable as the component might modify it
and pass it forwards. Null parameter is interpreted as empty
collection.void addListener(Component.Listener listener)
listener
- the new Listener to be registered.void removeListener(Component.Listener listener)
listener
- the listener to be removed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |