echopoint
Class ComponentEx

java.lang.Object
  nextapp.echo.app.Component
      echopoint.ComponentEx

All Implemented Interfaces:

Attributeable, Serializable, RenderIdSupport

Direct Known Subclasses:

AbleComponent, Separator

public abstract class ComponentEx
extends Component
implements Attributeable

ComponentEx is an abstract component that offers helper methods for getting and setting properties, beyond what the base nextapp.echo2.app.Component does.

The hidden property is an interesting one. This is a different visual property to visible.

In Echo2 components that are not visible do not exist at all as far as rendering is concerned. They get no property updates and will not exist in the client. The hidden flag simple makes the component "not shown" on the client. It still exists and can/will receive property updates.

The use of this flag can help the application become more efficient because server to client messaging is reduced when a parent component is hidden and then shown, as it may not redraw all sub components.

In CSS/XHTML terms, hidden is equivalent to display:none.

Version:

$Id$

Author:

Brad Baker

See Also:

Serialized Form

Field Summary

static String

PROPERTY_HIDDEN

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_NEXT_ID_CHANGED_PROPERTY, FOCUS_PREVIOUS_ID_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

ComponentEx()
ComponentEx does not participate in focus traversal by default.

Method Summary

static Object	get(Component c, String propertyName) Helper method to get 'Object' properties.
static boolean	get(Component c, String propertyName, boolean defaultValue) Helper method to get 'boolean' properties, with a default value.
static byte	get(Component c, String propertyName, byte defaultValue) Helper method to get 'byte' properties, with a default value.
static char	get(Component c, String propertyName, char defaultValue) Helper method to get 'char' properties, with a default value.
static double	get(Component c, String propertyName, double defaultValue) Helper method to get 'double' properties, with a default value.
static float	get(Component c, String propertyName, float defaultValue) Helper method to get 'float' properties, with a default value.
static int	get(Component c, String propertyName, int defaultValue) Helper method to get 'int' properties, with a default value.
static long	get(Component c, String propertyName, long defaultValue) Helper method to get 'long' properties, with a default value.
static Object	get(Component c, String propertyName, Object defaultValue) Helper method to get 'Object' properties, with a default value.
static short	get(Component c, String propertyName, short defaultValue) Helper method to get 'short' properties, with a default value.
boolean	get(String propertyName, boolean defaultValue) Helper method to get 'boolean' properties, with a default value.
byte	get(String propertyName, byte defaultValue) Helper method to get 'byte' properties, with a default value.
char	get(String propertyName, char defaultValue) Helper method to get 'char' properties, with a default value.
double	get(String propertyName, double defaultValue) Helper method to get 'double' properties, with a default value.
float	get(String propertyName, float defaultValue) Helper method to get 'float' properties, with a default value.
int	get(String propertyName, int defaultValue) Helper method to get 'int' properties, with a default value.
long	get(String propertyName, long defaultValue) Helper method to get 'long' properties, with a default value.
short	get(String propertyName, short defaultValue) Helper method to get 'short' properties, with a default value.
Object	getAttribute(String attributeName) Returns a value for the given attribute name or null if one cannot be found.
String[]	getAttributeNames() Returns a String array with the names of the the attributes that have neen set.
static Object	getRenderProperty(Component c, String propertyName) Helper method to get 'Object' render properties.
static boolean	getRenderProperty(Component c, String propertyName, boolean defaultValue) Helper method to get 'boolean' render properties, with a default value.
static byte	getRenderProperty(Component c, String propertyName, byte defaultValue) Helper method to get 'byte' render properties, with a default value.
static char	getRenderProperty(Component c, String propertyName, char defaultValue) Helper method to get 'char' render properties, with a default value.
static double	getRenderProperty(Component c, String propertyName, double defaultValue) Helper method to get 'double' render properties, with a default value.
static float	getRenderProperty(Component c, String propertyName, float defaultValue) Helper method to get 'float' render properties, with a default value.
static int	getRenderProperty(Component c, String propertyName, int defaultValue) Helper method to get 'int' render properties, with a default value.
static long	getRenderProperty(Component c, String propertyName, long defaultValue) Helper method to get 'long' render properties, with a default value.
static Object	getRenderProperty(Component c, String propertyName, Object defaultValue) Helper method to get 'Object' render properties.
static short	getRenderProperty(Component c, String propertyName, short defaultValue) Helper method to get 'short' render properties, with a default value.
boolean	getRenderProperty(String propertyName, boolean defaultValue) Helper method to get 'boolean' render properties, with a default value.
byte	getRenderProperty(String propertyName, byte defaultValue) Helper method to get 'byte' render properties, with a default value.
char	getRenderProperty(String propertyName, char defaultValue) Helper method to get 'char' render properties, with a default value.
double	getRenderProperty(String propertyName, double defaultValue) Helper method to get 'double' render properties, with a default value.
float	getRenderProperty(String propertyName, float defaultValue) Helper method to get 'float' render properties, with a default value.
int	getRenderProperty(String propertyName, int defaultValue) Helper method to get 'int' render properties, with a default value.
long	getRenderProperty(String propertyName, long defaultValue) Helper method to get 'long' render properties, with a default value.
short	getRenderProperty(String propertyName, short defaultValue) Helper method to get 'short' render properties, with a default value.
boolean	isHidden()
static void	set(Component c, String propertyName, boolean newValue) Helper method to set 'boolean' property values
static void	set(Component c, String propertyName, byte newValue) Helper method to set 'byte' property values
static void	set(Component c, String propertyName, char newValue) Helper method to set 'char' property values
static void	set(Component c, String propertyName, double newValue) Helper method to set 'double' property values
static void	set(Component c, String propertyName, float newValue) Helper method to set 'float' property values
static void	set(Component c, String propertyName, int newValue) Helper method to set 'int' property values
static void	set(Component c, String propertyName, long newValue) Helper method to set 'long' property values
static void	set(Component c, String propertyName, Object newValue) Helper method to set 'Object' property values
static void	set(Component c, String propertyName, short newValue) Helper method to set 'short' property values
void	set(String propertyName, boolean newValue) Helper method to set 'boolean' property values
void	set(String propertyName, byte newValue) Helper method to set 'byte' property values
void	set(String propertyName, char newValue) Helper method to set 'char' property values
void	set(String propertyName, double newValue) Helper method to set 'double' property values
void	set(String propertyName, float newValue) Helper method to set 'float' property values
void	set(String propertyName, int newValue) Helper method to set 'int' property values
void	set(String propertyName, long newValue) Helper method to set 'long' property values
void	set(String propertyName, short newValue) Helper method to set 'short' property values
void	setAttribute(String attributeName, Object attributeValue) Sets a value for a given attribute name.
void	setHidden(boolean newValue) Sets whether this ComponentEx (and its content) is hidden on the client.

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusNextId, getFocusPreviousId, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isValidParent, isVisible, processInput, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusNextId, setFocusPreviousId, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_HIDDEN

public static final String PROPERTY_HIDDEN

See Also:

Constant Field Values

Constructor Detail

ComponentEx

public ComponentEx()

ComponentEx does not participate in focus traversal by default.

Method Detail

isHidden

public boolean isHidden()

Returns:

true if the ComponentEx is currently hidden

setHidden

public void setHidden(boolean newValue)

Sets whether this ComponentEx (and its content) is hidden on the client.

This is a different visual property to visible. In Echo2 components that are not visible do not exist at all as far as rendering is concerned. They get no property updates and will not exist in the client. The hidden flag simple makes the component "not shown" on the client. It still exists and can receive property updates.

The use of this flag can help the application become more efficient because server to client messaging is reduced when a parent component is hidden and then shown, as it may not redraw all sub components.

In CSS/XHTML terms, hidden is equivalent to display:none.

Parameters:

newValue - - the new value of the hidden flag

get

public static Object get(Component c,
                         String propertyName)

Helper method to get 'Object' properties. Placed there for completeness since Component.getProperty() does exactly the same thing.

Returns:

- the 'Object' property

See Also:

Component.get(String)

get

public static Object get(Component c,
                         String propertyName,
                         Object defaultValue)

Helper method to get 'Object' properties, with a default value.

Parameters:

c -

propertyName -

defaultValue -

Returns:

- the 'Object' property

get

public static boolean get(Component c,
                          String propertyName,
                          boolean defaultValue)

Helper method to get 'boolean' properties, with a default value.

Returns:

- the 'boolean' property or the default value if its null

See Also:

Component.get(String)

get

public static byte get(Component c,
                       String propertyName,
                       byte defaultValue)

Helper method to get 'byte' properties, with a default value.

Returns:

- the 'byte' property or the default value if its null

See Also:

Component.get(String)

get

public static char get(Component c,
                       String propertyName,
                       char defaultValue)

Helper method to get 'char' properties, with a default value.

Returns:

- the 'char' property or the default value if its null

See Also:

Component.get(String)

get

public static double get(Component c,
                         String propertyName,
                         double defaultValue)

Helper method to get 'double' properties, with a default value.

Returns:

- the 'double' property or the default value if its null

See Also:

Component.get(String)

get

public static float get(Component c,
                        String propertyName,
                        float defaultValue)

Helper method to get 'float' properties, with a default value.

Returns:

- the 'float' property or the default value if its null

See Also:

Component.get(String)

get

public static int get(Component c,
                      String propertyName,
                      int defaultValue)

Helper method to get 'int' properties, with a default value.

Returns:

- the 'int' property or the default value if its null

See Also:

Component.get(String)

get

public static long get(Component c,
                       String propertyName,
                       long defaultValue)

Helper method to get 'long' properties, with a default value.

Returns:

- the 'long' property or the default value if its null

See Also:

Component.get(String)

get

public static short get(Component c,
                        String propertyName,
                        short defaultValue)

Helper method to get 'short' properties, with a default value.

Returns:

- the 'short' property or the default value if its null

See Also:

Component.get(String)

getRenderProperty

public static Object getRenderProperty(Component c,
                                       String propertyName)

Helper method to get 'Object' render properties. Placed there for completeness since Component.getRenderProperty() does exactly the same thing.

Returns:

- the 'Object' render property

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static boolean getRenderProperty(Component c,
                                        String propertyName,
                                        boolean defaultValue)

Helper method to get 'boolean' render properties, with a default value.

Returns:

- the 'boolean' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static byte getRenderProperty(Component c,
                                     String propertyName,
                                     byte defaultValue)

Helper method to get 'byte' render properties, with a default value.

Returns:

- the 'byte' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static char getRenderProperty(Component c,
                                     String propertyName,
                                     char defaultValue)

Helper method to get 'char' render properties, with a default value.

Returns:

- the 'char' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static double getRenderProperty(Component c,
                                       String propertyName,
                                       double defaultValue)

Helper method to get 'double' render properties, with a default value.

Returns:

- the 'double' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static float getRenderProperty(Component c,
                                      String propertyName,
                                      float defaultValue)

Helper method to get 'float' render properties, with a default value.

Returns:

- the 'float' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static int getRenderProperty(Component c,
                                    String propertyName,
                                    int defaultValue)

Helper method to get 'int' render properties, with a default value.

Returns:

- the 'int' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static long getRenderProperty(Component c,
                                     String propertyName,
                                     long defaultValue)

Helper method to get 'long' render properties, with a default value.

Returns:

- the 'long' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static Object getRenderProperty(Component c,
                                       String propertyName,
                                       Object defaultValue)

Helper method to get 'Object' render properties. Placed there for completeness since Component.getRenderProperty() does exactly the same thing.

Returns:

- the 'Object' render property

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public static short getRenderProperty(Component c,
                                      String propertyName,
                                      short defaultValue)

Helper method to get 'short' render properties, with a default value.

Returns:

- the 'short' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       boolean newValue)

Helper method to set 'boolean' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       byte newValue)

Helper method to set 'byte' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       char newValue)

Helper method to set 'char' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       double newValue)

Helper method to set 'double' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       float newValue)

Helper method to set 'float' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       int newValue)

Helper method to set 'int' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       long newValue)

Helper method to set 'long' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       Object newValue)

Helper method to set 'Object' property values

See Also:

Component.set(String, Object)

set

public static void set(Component c,
                       String propertyName,
                       short newValue)

Helper method to set 'short' property values

See Also:

Component.set(String, Object)

getAttribute

public Object getAttribute(String attributeName)

Description copied from interface: Attributeable

Returns a value for the given attribute name or null if one cannot be found.

Specified by:

getAttribute in interface Attributeable

Parameters:

attributeName - - the name of the attribute to return

Returns:

a value for the given attribute name or null if one cannot be found.

See Also:

Attributeable.getAttribute(java.lang.String)

getAttributeNames

public String[] getAttributeNames()

Description copied from interface: Attributeable

Returns a String array with the names of the the attributes that have neen set.

Specified by:

getAttributeNames in interface Attributeable

Returns:

a String array with the names of the the attributes that have neen set.

See Also:

Attributeable.getAttributeNames()

get

public boolean get(String propertyName,
                   boolean defaultValue)

Helper method to get 'boolean' properties, with a default value.

Returns:

- the 'boolean' property or the default value if its null

See Also:

Component.get(String)

get

public byte get(String propertyName,
                byte defaultValue)

Helper method to get 'byte' properties, with a default value.

Returns:

- the 'byte' property or the default value if its null

See Also:

Component.get(String)

get

public char get(String propertyName,
                char defaultValue)

Helper method to get 'char' properties, with a default value.

Returns:

- the 'char' property or the default value if its null

See Also:

Component.get(String)

get

public double get(String propertyName,
                  double defaultValue)

Helper method to get 'double' properties, with a default value.

Returns:

- the 'double' property or the default value if its null

See Also:

Component.get(String)

get

public float get(String propertyName,
                 float defaultValue)

Helper method to get 'float' properties, with a default value.

Returns:

- the 'float' property or the default value if its null

See Also:

Component.get(String)

get

public int get(String propertyName,
               int defaultValue)

Helper method to get 'int' properties, with a default value.

Returns:

- the 'int' property or the default value if its null

See Also:

Component.get(String)

get

public long get(String propertyName,
                long defaultValue)

Helper method to get 'long' properties, with a default value.

Returns:

- the 'long' property or the default value if its null

See Also:

Component.get(String)

get

public short get(String propertyName,
                 short defaultValue)

Helper method to get 'short' properties, with a default value.

Returns:

- the 'short' property or the default value if its null

See Also:

Component.get(String)

getRenderProperty

public boolean getRenderProperty(String propertyName,
                                 boolean defaultValue)

Helper method to get 'boolean' render properties, with a default value.

Returns:

- the 'boolean' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public byte getRenderProperty(String propertyName,
                              byte defaultValue)

Helper method to get 'byte' render properties, with a default value.

Returns:

- the 'byte' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public char getRenderProperty(String propertyName,
                              char defaultValue)

Helper method to get 'char' render properties, with a default value.

Returns:

- the 'char' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public double getRenderProperty(String propertyName,
                                double defaultValue)

Helper method to get 'double' render properties, with a default value.

Returns:

- the 'double' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public float getRenderProperty(String propertyName,
                               float defaultValue)

Helper method to get 'float' render properties, with a default value.

Returns:

- the 'float' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public int getRenderProperty(String propertyName,
                             int defaultValue)

Helper method to get 'int' render properties, with a default value.

Returns:

- the 'int' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public long getRenderProperty(String propertyName,
                              long defaultValue)

Helper method to get 'long' render properties, with a default value.

Returns:

- the 'long' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

getRenderProperty

public short getRenderProperty(String propertyName,
                               short defaultValue)

Helper method to get 'short' render properties, with a default value.

Returns:

- the 'short' render property or the default value if its null

See Also:

Component.getRenderProperty(String, Object)

setAttribute

public void setAttribute(String attributeName,
                         Object attributeValue)

Description copied from interface: Attributeable

Sets a value for a given attribute name.

Specified by:

setAttribute in interface Attributeable

Parameters:

attributeName - - the name of the attribute to set

attributeValue - - the value for the attribute

See Also:

Attributeable.setAttribute(java.lang.String, java.lang.Object)

set

public void set(String propertyName,
                boolean newValue)

Helper method to set 'boolean' property values

See Also:

Component.set(String, Object)

set

public void set(String propertyName,
                byte newValue)

Helper method to set 'byte' property values

See Also:

Component.set(String, Object)

set

public void set(String propertyName,
                char newValue)

Helper method to set 'char' property values

See Also:

Component.set(String, Object)

set

public void set(String propertyName,
                double newValue)

Helper method to set 'double' property values

See Also:

Component.set(String, Object)

set

public void set(String propertyName,
                float newValue)

Helper method to set 'float' property values

See Also:

Component.set(String, Object)

set

public void set(String propertyName,
                int newValue)

Helper method to set 'int' property values

See Also:

Component.set(String, Object)

set

public void set(String propertyName,
                long newValue)

Helper method to set 'long' property values

See Also:

Component.set(String, Object)

set

public void set(String propertyName,
                short newValue)

Helper method to set 'short' property values

See Also:

Component.set(String, Object)