|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nextapp.echo.webcontainer.AbstractCommandSynchronizePeer
public abstract class AbstractCommandSynchronizePeer
Default abstract implementation of CommandSynchronizePeer
.
Nested Class Summary | |
---|---|
static interface |
AbstractCommandSynchronizePeer.IndexedPropertyPeer
A peer for rendering an indexed property of a Command . |
static interface |
AbstractCommandSynchronizePeer.PropertyPeer
A peer for rendering a non-indexed property of a Command . |
Constructor Summary | |
---|---|
AbstractCommandSynchronizePeer()
|
Method Summary | |
---|---|
void |
addProperty(java.lang.String propertyName,
AbstractCommandSynchronizePeer.IndexedPropertyPeer propertyPeer)
Adds an indexed property that will be rendered using an IndexedPropertyPeer . |
void |
addProperty(java.lang.String propertyName,
AbstractCommandSynchronizePeer.PropertyPeer propertyPeer)
Adds a non-indexed property that will be rendered using a PropertyPeer . |
void |
addProperty(java.lang.String propertyName,
boolean indexed)
Adds a property. |
java.lang.String |
getClientCommandType()
Returns the remote client component name. |
java.lang.Object |
getProperty(nextapp.echo.app.util.Context context,
nextapp.echo.app.Command command,
java.lang.String propertyName,
int propertyIndex)
Returns the value of a specific property. |
java.util.Iterator |
getPropertyIndices(nextapp.echo.app.util.Context context,
nextapp.echo.app.Command command,
java.lang.String propertyName)
Determines which indices of a particular property are set. |
java.util.Iterator |
getPropertyNames(nextapp.echo.app.util.Context context,
nextapp.echo.app.Command command)
Returns an Iterator over the collection of names of all
output properties that should be rendered to the remote client. |
void |
init(nextapp.echo.app.util.Context context)
Initializes the peer. |
boolean |
isPropertyIndexed(nextapp.echo.app.util.Context context,
nextapp.echo.app.Command command,
java.lang.String propertyName)
Determines if the specified output property is indexed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface nextapp.echo.webcontainer.CommandSynchronizePeer |
---|
getCommandClass |
Constructor Detail |
---|
public AbstractCommandSynchronizePeer()
Method Detail |
---|
public void addProperty(java.lang.String propertyName, AbstractCommandSynchronizePeer.PropertyPeer propertyPeer)
PropertyPeer
.
propertyName
- the name of the propertypropertyPeer
- the PropertyPeer
which will render itpublic void addProperty(java.lang.String propertyName, AbstractCommandSynchronizePeer.IndexedPropertyPeer propertyPeer)
IndexedPropertyPeer
.
propertyName
- the name of the propertypropertyPeer
- the IndexedPropertyPeer
which will render itpublic void addProperty(java.lang.String propertyName, boolean indexed)
getPropertyName()
method of this class.
If the indexed flag is set, the isPropertyIndexed
method will also return true for this property name
propertyName
- the property name to addindexed
- a flag indicating whether the property is indexedpublic java.lang.String getClientCommandType()
CommandSynchronizePeer
getClientCommandType
in interface CommandSynchronizePeer
CommandSynchronizePeer.getClientCommandType()
public java.lang.Object getProperty(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName, int propertyIndex)
CommandSynchronizePeer
getProperty
in interface CommandSynchronizePeer
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the Command
being renderedpropertyName
- the name of the property being renderedpropertyIndex
- the property index (only relevant for indexed properties, -1 will
be provided for non-indexed properties)
CommandSynchronizePeer.getProperty(nextapp.echo.app.util.Context,
nextapp.echo.app.Command, java.lang.String, int)
public java.util.Iterator getPropertyIndices(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName)
CommandSynchronizePeer
isPropertyIndexed()
has returned true.
getPropertyIndices
in interface CommandSynchronizePeer
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the commandpropertyName
- the property name
Iterator
that returns the set indices in
incrementing order as Integer
sCommandSynchronizePeer.getPropertyIndices(nextapp.echo.app.util.Context,
nextapp.echo.app.Command, java.lang.String)
public java.util.Iterator getPropertyNames(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command)
CommandSynchronizePeer
Iterator
over the collection of names of all
output properties that should be rendered to the remote client. Only the
names of properties with non-default values should be returned.
getPropertyNames
in interface CommandSynchronizePeer
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the command
Iterator
of property namesCommandSynchronizePeer.getPropertyNames(nextapp.echo.app.util.Context,
nextapp.echo.app.Command)
public void init(nextapp.echo.app.util.Context context)
CommandSynchronizePeer
Command
for the first time.
init
in interface CommandSynchronizePeer
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
CommandSynchronizePeer.init(nextapp.echo.app.util.Context)
public boolean isPropertyIndexed(nextapp.echo.app.util.Context context, nextapp.echo.app.Command command, java.lang.String propertyName)
CommandSynchronizePeer
isPropertyIndexed
in interface CommandSynchronizePeer
context
- the relevant Context
, provides
standard contextual information described in class description, in
addition to the following:
command
- the commandpropertyName
- the property name
CommandSynchronizePeer.isPropertyIndexed(nextapp.echo.app.util.Context,
nextapp.echo.app.Command, java.lang.String)
|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |