nextapp.echo
Interface Component

All Known Implementing Classes:

AbstractButton, AbstractButton, AbstractComponent, AbstractConstantEditor, AbstractDateTimeField, AbstractDynaPickList, AbstractLayout, AbstractListBoxDemoPanel, AbstractMeterComponent, AbstractNumberEditor, AbstractNumberEditorDemoPanel, AbstractNumberViewer, AbstractPane, AbstractPropertiesFileScreen, AbstractScreen, AbstractScrollableComponent, AbstractUnitTestCustomComponent, ActionBar, ActionBarDemoPanel, AskScriptNameDialog, AskVariableNameDialog, AsyncComponent, AsynchContentPane, AsyncIntegerEditor, AsyncIntegerViewer, AsyncStringViewer, BalloonHelp, Beep, BigDecimalEditor, BigDecimalEditorDemoPanel, BigDecimalViewer, BlackHole, BlankScreen, BooleanEditor, BooleanImageViewer, BooleanImageViewerDemoPanel, BooleanViewer, BorderStyleEditor, BoxSection, Button, ButtonReport, ByteEditor, ByteEditorDemoPanel, ByteViewer, CalibrationScreen, CButton, ChartPanel, CheckBox, ClassEditorDemoPanel, ClassNameEditor, ClientDatePicker, ClientSideComponentSelector, CloseDivComponent, ColorChooser, Column, ColumnAndRowUnitsEditor, ColumnSortCriterionEditor, ComboBox, CompactColorEditor, ComponentInspector, ComponentInspectorDialog, ComponentTypeEditor, CompoundComponent, ConfirmButton, Container, ContainerPane, ContentPane, CriteriaGrid, CriteriaGridDemoPanel, CSSButton, CSSComponent, CSSLabel, CustomComponent, CustomRenderingComponent, DateEditor, DateField, DatePicker, DateTimeEditor, DateTimeViewer, DateViewer, DefaultDynaTreeModel.NodeViewer, DefaultPdfLayout, DefaultTreeCellRenderer, DevNull, DHLLayout, Dialog, DialogDemoPanel, DialogPanel, DoubleEditor, DoubleEditorDemoPanel, DoubleViewer, Download, DragWrapper, DropDownBox, DropWrapper, DummyComponent, DynaButton, DynaButtonDemoPanel, DynaCheckBox, DynaCheckBoxDemoPanel, DynaColorChooser, DynaColorChooserDemoPanel, DynaColorChooserDialog, DynaCompletionBox, DynaCompletionBoxDemoPanel, DynaConfirmButton, DynaConfirmButtonDemoPanel, DynaDateField, DynaDateFieldDemoPanel, DynaDateTimeField, DynaDateTimeFieldDemoPanel, DynaGrid, DynaGrid.Cell, DynaGridDemoPanel, DynaGridReport, DynaHtmlContainer, DynaHtmlContainerDemoPanel, DynaHtmlEditor, DynaHtmlEditorDemoPanel, DynaLabel, DynaLabelDemoPanel, DynaLargeListBox, DynaLargeListBoxDemoPanel, DynaLargePickList, DynaLargePickListDemoPanel, DynaLink, DynaLinkDemoPanel, DynaListBox, DynaListBoxDemoPanel, DynaPasswordField, DynaPasswordFieldDemoPanel, DynaPickList, DynaPickListDemoPanel, DynaQuickSelectField, DynaQuickSelectFieldDemoPanel, DynaQuickSelectFieldDialog, DynaRadioButtonList, DynaRadioButtonListDemoPanel, DynaSaveButton, DynaSaveButtonDemoPanel, DynaSelectField, DynaSelectFieldDemoPanel, DynaTabbedPane, DynaTabbedPaneDemoPanel, DynaTable, DynaTableDemoPanel, DynaTableReport, DynaTableReport.MyCustomComp, DynaTableSortDialog, DynaTextArea, DynaTextAreaDemoPanel, DynaTextField, DynaTextFieldDemoPanel, DynaTimeField, DynaTimeFieldDemoPanel, DynaTree, DynaTreeDemoPanel, DynaTreeDemoPanel.DemoNodeViewer, EchoPointComponent, EmbeddedObject, EmbeddedPane, ErrorMessagesComponent, ErrorMessagesComponentDemoPanel, ExitButton, ExpandableMenu, ExpandableSection, ExternalEventMonitor, ExternalSiteViewer, FilePane, Filler, FloatEditor, FloatEditorDemoPanel, FloatViewer, FontChooser, FontChooser.DefaultPreviewPanel, FontEditor, GalleryScreen, GeneralSettingsScreen, GlobalExceptionScreen, Grid, Grid.Cell, GridPanel, GroupBox, HeapInspectorScreen, HidingSlidingPanel, HistoryController, HorizontalAlignmentEditor, HorizontalPanel, HourGlass, HtmlContainer, HtmlTemplatePanel, HttpPane, ImageIcon, ImageMap, InsetsCompactEditor, InsetsEditor, InsetsEditorDialog, IntegerEditor, IntegerEditorDemoPanel, IntegerRangeSelector, IntegerViewer, JamonScreen, JavaBeanPropertyEditor, JavaBeanPropertyEditorDialog, JavaScriptButton, JavaScriptInclude, JspTemplatePanel, KeyActionCommand, Label, Label, LargeStringViewer, LargeStringViewerDemoPanel, Line, ListBox, ListElementPropertyGrid, ListSection, LogoffScreen, LongEditor, LongEditorDemoPanel, LongStringViewer, LongViewer, Menu, MenuBar, MenuBar, MenuEditorScreen, MenuEditorScreen.MenuSpecViewer, MenuItem, MenuSpecEditor, MockComponent, MockLayout, MockPropertyComponent, MockScreen, MouseCursorEditor, MySortableTableHeaderRenderer, NativeCheckBox, NavigationHistory, NewsManagerScreen, NewsTicker, NewsTicker, NewsTickerDemoPanel, NonSortableTableHeaderRenderer, NumberFormatField, OnLoadScriptOnceComponent, OpenDivComponent, OptimisticLockExceptionScreen, PackagesController, PagedTableController, PageServedComponent, Panel, Panel, PasswordField, PasswordField, PdfBookmarkComponent, PdfNewPage, PdfReportComponent, PersistencySettingsScreen, PickList, PickScriptVariableDialog, PopUp, PopWrapper, PopWrapperDemoPanel, PopWrapperModeEditor, PreloadImagesComponent, PrintRequest, ProgressBar, PropertyEditor, PropertyGrid, PropertyGridDemoPanel, PushButton, RadioButton, RebindableCompoundComponent, RecallComboBox, ReRunButton, RescheduleSelector, RichTextArea, Row, SchedulerController, ScrapDialog, ScrapScreen, Screen, ScriptRecorder, ScrollableBox, ScrollablePanel, ScrollablePanel2, ScrollBarPolicyEditor, SecondLevelCacheScreen, SecuritySettingEditor, SecuritySettingsScreen, SelectableTable, SelectField, SelectScriptDialog, Separator, ServerFileNameCompactEditor, ServerFileNameDialog, ServerFileNameEditor, SessionOverviewScreen, ShortEditor, ShortEditorDemoPanel, ShortViewer, SortableTable, SortableTableHeaderRenderer, SpinField, StackedPane, StackTraceViewerDialog, StopButton, StringEditor, StringEditorDemoPanel, StringIconViewer, StringViewer, StringViewerDemoPanel, StyleManagerEditStyleDialog, StyleManagerScreen, SubmitButton, SuccessStringViewer, TabbedPane, TabbedPane, Table, TableHeader, TabPlacementEditor, TaskBar, TestDialog, TextArea, TextComponent, TextField, TextField, TimeField, Timer, Timer, TimerDemoPanel, TimeViewer, Title, TitleBar, ToggleButton, ToolBarStyleEditor, ToolTipPopUp, TransactionModeEditor, TransactionSettingsScreen, Tree, UnitsEditor, UnitTestController, UnitTestScreen, UploadSelect, ValidationDialog, VerticalAlignmentEditor, ViewStackTraceButton, VugenRecorder, WelcomeScreen, Window, WizardPane, ZenoLayout

public interface Component

Field Summary

static java.lang.String	BACKGROUND_CHANGED_PROPERTY
static java.lang.String	CHILDREN_CHANGED_PROPERTY
static java.lang.String	ENABLED_CHANGED_PROPERTY
static java.lang.String	FONT_CHANGED_PROPERTY
static java.lang.String	FOREGROUND_CHANGED_PROPERTY
static java.lang.String	IDENTIFIER_CHANGED_PROPERTY
static java.lang.String	LOCALE_CHANGED_PROPERTY
static java.lang.String	MODEL_CHANGED_PROPERTY
static java.lang.String	SELECTABLE_CHANGED_PROPERTY
static java.lang.String	STYLE_BACKGROUND A style constant for the Background property.
static java.lang.String	STYLE_FONT A style constant for the Font property.
static java.lang.String	STYLE_FOREGROUND A style constant for the Foreground property.
static java.lang.String	UPDATE_PROPERTY
static java.lang.String	VISIBLE_CHANGED_PROPERTY

Method Summary

void	add(Component c) Adds the specified Component at the end of this Component's children.
void	add(Component c, int n) Adds the specified Component as the nth child All component add operations use this method to add components.
void	addHierarchyListener(HierarchyListener l) Adds a hierarchy listener to be notified when this component's state in the hierarchy changes.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds a property change listener to this component.
void	applyStyle(Style style) Sets stylistic properties of this component based on a Style object.
void	firePropertyChange(java.lang.String propertyName, boolean oldValue, boolean newValue) Reports a bound property change.
void	firePropertyChange(java.lang.String propertyName, char oldValue, char newValue) Reports a bound property change.
void	firePropertyChange(java.lang.String propertyName, double oldValue, double newValue) Reports a bound property change.
void	firePropertyChange(java.lang.String propertyName, float oldValue, float newValue) Reports a bound property change.
void	firePropertyChange(java.lang.String propertyName, int oldValue, int newValue) Reports a bound property change.
void	firePropertyChange(java.lang.String propertyName, long oldValue, long newValue) Reports a bound property change.
void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Reports a bound property change.
Color	getBackground() Returns the background color of the component.
java.lang.String	getClientId() Gets the reuseable Id, this is used to keep component peer id constant over show/hide cycles.
Component	getComponent(int n) Gets the nth immediate child component.
int	getComponentCount() Returns the number of immediate child components.
Component[]	getComponents() Returns an array of all immediate child components.
EchoInstance	getEchoInstance() Returns the EchoInstance object to which this component belongs, or null if it is not bound to any instance.
Font	getFont() Returns the font.
Color	getForeground() Returns the foreground of the component.
java.lang.Object	getIdentifier() Returns the identifier for this component.
EventListenerList	getListenerList()
java.util.Locale	getLocale() Returns the locale of the component.
Component	getParent() Returns the parent component.
int	indexOf(Component c) Returns the index of the specified component if it a child of this Component, or -1 if it is not.
void	init()
boolean	isAncestorOf(Component c) Determines if this component is an ancestor of the specified component.
boolean	isEnabled() Returns true if the component is enabled.
boolean	isFocused() Returns true if the component is focused.
boolean	isRecursivelyVisible()
boolean	isRegistered() Returns true if the component is registered to an application.
boolean	isSelectableForScriptRecorder()
boolean	isShowing() Returns true if the component is registered and all of its ancestors are visible.
boolean	isVisible() Returns the component's visibility state.
void	processHierarchyEvent(long changeFlags, Component c, Component parent)
void	remove(Component c) Removes the specified child component.
void	remove(int n) Removes the component at the given index.
void	removeAll() Removes all child Components.
void	removeHierarchyListener(HierarchyListener l) Removes a hierarchy listener from being notified when this component's state in the hierarchy changes.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes a property change listener from this component.
void	setBackground(Color newValue) Sets the background color of the component.
void	setClientId(java.lang.String reusableId) Sets the reuseable Id, this is used to keep component peer id constant over show/hide cycles.
void	setEnabled(boolean newValue) Sets whether the component is enabled.
void	setFocused(boolean newValue) Sets whether the component is focused.
void	setFont(Font newValue) Sets the font of the component.
void	setForeground(Color newValue) Sets the foreground color of the component.
void	setIdentifier(java.lang.Object newValue) Sets the identifier for this component.
void	setLocale(java.util.Locale newValue) Sets the locale of the component.
void	setParent(Component component)
void	setRegistered(boolean b)
void	setSelectableForScriptRecorder(boolean b)
void	setVisible(boolean newValue) Sets the component visible or invisible.
void	update() Forces the component to be re-rendered immediately.
void	validate() Validates this component.

Field Detail

BACKGROUND_CHANGED_PROPERTY

static final java.lang.String BACKGROUND_CHANGED_PROPERTY

See Also:

Constant Field Values

CHILDREN_CHANGED_PROPERTY

static final java.lang.String CHILDREN_CHANGED_PROPERTY

See Also:

Constant Field Values

ENABLED_CHANGED_PROPERTY

static final java.lang.String ENABLED_CHANGED_PROPERTY

See Also:

Constant Field Values

FONT_CHANGED_PROPERTY

static final java.lang.String FONT_CHANGED_PROPERTY

See Also:

Constant Field Values

FOREGROUND_CHANGED_PROPERTY

static final java.lang.String FOREGROUND_CHANGED_PROPERTY

See Also:

Constant Field Values

IDENTIFIER_CHANGED_PROPERTY

static final java.lang.String IDENTIFIER_CHANGED_PROPERTY

See Also:

Constant Field Values

LOCALE_CHANGED_PROPERTY

static final java.lang.String LOCALE_CHANGED_PROPERTY

See Also:

Constant Field Values

MODEL_CHANGED_PROPERTY

static final java.lang.String MODEL_CHANGED_PROPERTY

See Also:

Constant Field Values

UPDATE_PROPERTY

static final java.lang.String UPDATE_PROPERTY

See Also:

Constant Field Values

VISIBLE_CHANGED_PROPERTY

static final java.lang.String VISIBLE_CHANGED_PROPERTY

See Also:

Constant Field Values

SELECTABLE_CHANGED_PROPERTY

static final java.lang.String SELECTABLE_CHANGED_PROPERTY

See Also:

Constant Field Values

STYLE_BACKGROUND

static final java.lang.String STYLE_BACKGROUND

A style constant for the Background property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

STYLE_FONT

static final java.lang.String STYLE_FONT

A style constant for the Font property. Values of this key must be of type nextapp.echo.Font.

See Also:

Constant Field Values

STYLE_FOREGROUND

static final java.lang.String STYLE_FOREGROUND

A style constant for the Foreground property. Values of this key must be of type nextapp.echo.Color.

See Also:

Constant Field Values

Method Detail

add

void add(Component c)

Adds the specified Component at the end of this Component's children.

Parameters:

c - The child component to add.

add

void add(Component c,
         int n)

Adds the specified Component as the nth child All component add operations use this method to add components. Components that require notification of all child additions should override this method (making sure to call the superclass' implementation).

Parameters:

c - The child component to add.

n - The index at which to add the child component, or -1 to add the component at the end.

addHierarchyListener

void addHierarchyListener(HierarchyListener l)

Adds a hierarchy listener to be notified when this component's state in the hierarchy changes.

Parameters:

l - The HierarchyListener to add.

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds a property change listener to this component.

Parameters:

l - The listener to add.

applyStyle

void applyStyle(Style style)

Sets stylistic properties of this component based on a Style object. The version of this method in Component will set foreground and background colors and the font from the style if they are present. Components should override this method if they allow more properties to be set from a style object, and should call super.applyStyle() if necessary.

Parameters:

style - The style object from which to retrieve properties for this Component.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        java.lang.Object oldValue,
                        java.lang.Object newValue)

Reports a bound property change.

Parameters:

propertyName - The name of the changed property.

oldValue - The previous value of the property.

newValue - The present value of the property.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        boolean oldValue,
                        boolean newValue)

Reports a bound property change.

Parameters:

propertyName - The name of the changed property.

oldValue - The previous value of the property.

newValue - The present value of the property.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        char oldValue,
                        char newValue)

Reports a bound property change.

Parameters:

propertyName - The name of the changed property.

oldValue - The previous value of the property.

newValue - The present value of the property.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        double oldValue,
                        double newValue)

Reports a bound property change.

Parameters:

propertyName - The name of the changed property.

oldValue - The previous value of the property.

newValue - The present value of the property.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        float oldValue,
                        float newValue)

Reports a bound property change.

Parameters:

propertyName - The name of the changed property.

oldValue - The previous value of the property.

newValue - The present value of the property.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        int oldValue,
                        int newValue)

Reports a bound property change.

Parameters:

propertyName - The name of the changed property.

oldValue - The previous value of the property.

newValue - The present value of the property.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        long oldValue,
                        long newValue)

Reports a bound property change.

Parameters:

propertyName - The name of the changed property.

oldValue - The previous value of the property.

newValue - The present value of the property.

getBackground

Color getBackground()

Returns the background color of the component.

Returns:

The background color of the component.

getComponent

Component getComponent(int n)

Gets the nth immediate child component.

Parameters:

n - The index of the component to retrieve.

Returns:

The component at index n.

Throws:

java.lang.IndexOutOfBoundsException - If the index is invalid.

getComponentCount

int getComponentCount()

Returns the number of immediate child components.

Returns:

The number of immediate child components.

getComponents

Component[] getComponents()

Returns an array of all immediate child components.

Returns:

An array of all immediate child components.

getEchoInstance

EchoInstance getEchoInstance()

Returns the EchoInstance object to which this component belongs, or null if it is not bound to any instance.

Returns:

The EchoInstance object to which this component belongs.

getFont

Font getFont()

Returns the font.

Returns:

The font of the component.

getForeground

Color getForeground()

Returns the foreground of the component.

Returns:

The foreground of the component.

getIdentifier

java.lang.Object getIdentifier()

Returns the identifier for this component. Every component may have an identifier. Identifiers are provided as a convenience to the application developer, and are not used internally in any manner.

Returns:

The identifier for this component.

getLocale

java.util.Locale getLocale()

Returns the locale of the component. If the component does not have a locale, its ancestors will be queried for a locale. If no ancestors have locales set, the application instance's locale will be returned. If the component is not registered, the active application instance's will be returned.

Returns:

The locale for this component.

getParent

Component getParent()

Returns the parent component.

Returns:

The parent component.

indexOf

int indexOf(Component c)

Returns the index of the specified component if it a child of this Component, or -1 if it is not.

Parameters:

c - The component to determine the index of.

Returns:

The index of the specified component.

isAncestorOf

boolean isAncestorOf(Component c)

Determines if this component is an ancestor of the specified component.

Parameters:

c - The component to test for ancestry.

Returns:

true If this component is an ancestor of the specified component.

isEnabled

boolean isEnabled()

Returns true if the component is enabled.

Returns:

True if the component is enabled.

isFocused

boolean isFocused()

Returns true if the component is focused.

Returns:

True if the component is focused.

isRegistered

boolean isRegistered()

Returns true if the component is registered to an application.

Returns:

True if the component is registered to an application.

isShowing

boolean isShowing()

Returns true if the component is registered and all of its ancestors are visible.

Returns:

True if the component is registered and all of its ancestors are visible.

isVisible

boolean isVisible()

Returns the component's visibility state.

Returns:

The component's visibility state.

remove

void remove(Component c)

Removes the specified child component. All component remove operations use this method to remove components. Components that require notification of all child removals should override this method (making sure to call the superclass' implementation).

Parameters:

c - The child component to remove.

remove

void remove(int n)

Removes the component at the given index.

Parameters:

n - The index of the child component to remove.

Throws:

java.lang.IndexOutOfBoundsException - If the index is not valid.

removeAll

void removeAll()

Removes all child Components.

removeHierarchyListener

void removeHierarchyListener(HierarchyListener l)

Removes a hierarchy listener from being notified when this component's state in the hierarchy changes.

Parameters:

l - The HierarchyListener to remove.

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes a property change listener from this component.

Parameters:

l - The listener to be removed.

setBackground

void setBackground(Color newValue)

Sets the background color of the component.

Parameters:

newValue - The new background color of the component.

setEnabled

void setEnabled(boolean newValue)

Sets whether the component is enabled.

Parameters:

newValue - True if the component is enabled.

setFocused

void setFocused(boolean newValue)

Sets whether the component is focused.

Parameters:

newValue - True if the component is to be focused.

setFont

void setFont(Font newValue)

Sets the font of the component.

Parameters:

newValue - The new font of the component.

setForeground

void setForeground(Color newValue)

Sets the foreground color of the component.

Parameters:

newValue - The new foreground color of the component.

setIdentifier

void setIdentifier(java.lang.Object newValue)

Sets the identifier for this component. Every component may have an identifier. Identifiers are provided as a convenience to the application developer, and are not used internally in any manner.

Parameters:

newValue - The new identifier for this component.

setLocale

void setLocale(java.util.Locale newValue)

Sets the locale of the component.

Parameters:

newValue - The new locale for the component.

setVisible

void setVisible(boolean newValue)

Sets the component visible or invisible.

Parameters:

newValue - The new visibility state of the component.

update

void update()

Forces the component to be re-rendered immediately. Fires a property change event indicating that any/all properties of the Component changed, forcing the container to re-render it.

validate

void validate()

Validates this component. This method will be called by the application container before the component is rendered. This method should be overridden if the component needs to be updated before being rendered. Validation occurs from the top of the component hierarchy down. Overriding methods should take care to first call super.validate() to ensure the superclass is validated as well.

If components above this one in the hierarchy are modified by an overriding implementation of this method, those components WILL NOT be automatically revalidated. Thus, performing such operations in validate() is not inadvisable.

getClientId

java.lang.String getClientId()

Gets the reuseable Id, this is used to keep component peer id constant over show/hide cycles.

setClientId

void setClientId(java.lang.String reusableId)

Sets the reuseable Id, this is used to keep component peer id constant over show/hide cycles. Do not call from your application code !

setParent

void setParent(Component component)

setRegistered

void setRegistered(boolean b)

isRecursivelyVisible

boolean isRecursivelyVisible()

processHierarchyEvent

void processHierarchyEvent(long changeFlags,
                           Component c,
                           Component parent)

init

void init()

getListenerList

EventListenerList getListenerList()

setSelectableForScriptRecorder

void setSelectableForScriptRecorder(boolean b)

isSelectableForScriptRecorder

boolean isSelectableForScriptRecorder()