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.
* *Components should be enabled by default.
* * @returntrue if the component is enabled,
* false if not
* @see VariableOwner#isEnabled()
*/
public boolean isEnabled();
/** Enable or disable the component. Being enabled means that the
* component can be edited. This method will trigger a
* {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}.
*
* @param enabled boolean value specifying if the component should be
* enabled after the call or not
*/
public void setEnabled(boolean enabled);
/** Tests if the component is visible or not. Visibility defines if the
* component is shown in the UI or not. Default is true.
*
* @return true if the component is visible in the UI,
* false if not
*/
public boolean isVisible();
/** Sets the components visibility status. Visibility defines if the
* component is shown in the UI or not.
*
* @param visible Boolean value specifying if the component should be
* visible after the call or not
*/
public void setVisible(boolean visible);
/** Gets the visual parent of the component. The components can be
* nested but one component can have only one parent.
*
* @return the parent component
*/
public Component getParent();
/** Sets the component's parent component.
*
* This method calls
* automatically {@link #attach()} if the parent is attached to a
* window (or is itself a window}, and {@link #detach()} if
* parent is set null, but the component
* was in the application.
This method is rarely called directly. Instead the
* {@link ComponentContainer#addComponent(Component)} method is used
* to add components to container, which call this method implicitly.
*
* @param parent the new parent component
*/
public void setParent(Component parent);
/** Tests if the component is in read-only mode.
*
* @return true if the component is in read-only mode,
* false if not
*/
public boolean isReadOnly();
/** Sets the component's to read-only mode to the specified state. This
* method will trigger a
* {@link com.itmill.toolkit.terminal.Paintable.RepaintRequestEvent RepaintRequestEvent}.
*
* @param readOnly boolean value specifying if the component should be
* in read-only mode after the call or not
*/
public void setReadOnly(boolean readOnly);
/** Gets the caption of the component. Caption is the visible name of
* the component.
*
* @return component's caption String
*/
public String getCaption();
/** Gets the component's icon. A component may have a graphical icon
* associated with it, this method retrieves it if it is defined.
*
* @return the component's icon or null if it not defined.
*/
public Resource getIcon();
/** Gets the component's parent window. If the component does not yet
* belong to a window null is returned.
*
* @return parent window of the component or null
*/
public Window getWindow();
/** Gets the component's parent application. If the component does not
* yet belong to a application null is returned.
*
* @return parent application of the component or null
*/
public Application getApplication();
/** 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() functions might return null
* before this method is called.
The caller of this method is {@link #setParent(Component)} if the * parent is already in the application. If the parent is not in the * application, it must call the {@link #attach()} for all its children * when it will be added to the application.
*/ public void attach(); /** Notifies the component that it is detached from the application. *The {@link #getApplication()} and {@link #getWindow()}
* methods might return null after this method is
* called.
The caller of this method is {@link #setParent(Component)} if the * parent is in the application. When the parent is detached from the application * it is its response to call {@link #detach()} for all the children and * to detach itself from the terminal.
*/ public void detach(); /** Gets the locale of this component. * * @return This component's locale. If this component does not have a * locale, the locale of its parent is returned. Eventually locale * of application is returned. If application does not have its own * locale the locale is determined by Locale.getDefautl(). 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. */ public Locale getLocale(); /** The children must call this method when they need repainting. The call must be * made event in the case the children sent the repaint request themselves. * @param alreadyNotified A 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. */ public void childRequestedRepaint(Collection alreadyNotified); /* Component event framework *************************************** */ /** Superclass of all component originatedEvents. */
public class Event extends EventObject {
/**
* Serial generated by eclipse.
*/
private static final long serialVersionUID = 4048791277653274933L;
/** Constructs a new event with a specified source component.
*
* @param source source component of the event
*/
public Event(Component source) {
super(source);
}
}
/** Listener interface for receiving Component.Events */
public interface Listener extends EventListener {
/** Notifies the listener of a component event.
*
* @param event the event that has occured
*/
public void componentEvent(Component.Event event);
}
/** Registers a new component event listener for this component.
*
* @param listener the new Listener to be registered
*/
public void addListener(Component.Listener listener);
/** Removes a previously registered component event listener from this
* component.
*
* @param listener the listener to be removed
*/
public void removeListener(Component.Listener listener);
/** Class of all component originated ErrorEvents. */
public class ErrorEvent extends Event {
/**
* Serial generated by eclipse.
*/
private static final long serialVersionUID = 4051323457293857333L;
private ErrorMessage message;
/** Constructs a new event with a specified source component.
*
* @param source source component of the event
*/
public ErrorEvent(
ErrorMessage message,
Component component) {
super(component);
this.message = message;
}
/** Return the error message */
public ErrorMessage getErrorMessage() {
return this.message;
}
}
/** Listener interface for receiving Component.Errorss */
public interface ErrorListener extends EventListener {
/** Notifies the listener of a component error.
*
* @param event the event that has occured
*/
public void componentError(Component.ErrorEvent event);
}
/** Interface implemented by components which can obtain input focus. */
public interface Focusable {
/** Set focus to this component.*/
public void focus();
/** Get Tabulator index of this Focusable component.
* @return Positive tab order of this focusable. Negative of zero means
* unspecified tab order.
*/
public int getTabIndex();
/** Set Tabulator index of this Focusable component.
* @param tabIndex Positive tab order of this focusable. Negative of
* zero means unspecified tab order.
*/
public void setTabIndex(int tabIndex);
/** Get unique ID of focusable.
* This will be used to move input focus directly to this
* component.
* @return Unique id of focusable.
*/
public long getFocusableId();
}
}