|
| |
|
| java.lang.Object
 com.jcorporate.expresso.core.controller.ControllerElement
com.jcorporate.expresso.core.controller.Output
| Output | | public class Output extends ControllerElement implements Cloneable,Cacheable,java.io.Serializable(Code) | | An item returned from a controller to provide output/feedback to the
client.
An Output object is one of the three types of object that can be returned
by a Controller moving to a new state. The other two are Input and
Action items.
An Output item can be a single item, or a list of items, using the "nested"
methods in the ControllerElement class.
|
| Output | | public Output()(Code) | | Default constructor
|
| Output | | public Output(String c)(Code) | | Convenience constructor for creating an output with a specific
string as it's contents in one step
Parameters:
c - The string contents of this Output item |
| Output | | public Output(String name, String c)(Code) | | Convenience constructor for creating an output with a specific
string as it's contents and a name in one step
Parameters:
name - The name of this new Output item
Parameters:
c - The string contents of the Output item |
| addNested | | public void addNested(Output o)(Code) | | Add a new nested output item to this item
Parameters:
o - The new Output item to be nested into this one |
| clearUsedCount | | public void clearUsedCount()(Code) | | Clears the used count
|
| getAlignment | | public String getAlignment()(Code) | | Get the suggested alignment for this item
The suggested alignment for this Output item |
| getContent | | public String getContent()(Code) | | Get the "contents" of this Output, the string value that this
Output object represents
A String value for the contents of this Output |
| getDefaultValue | | public String getDefaultValue()(Code) | | Return contents; convenience method to unify Input/Output method names
A String content |
| getKey | | public String getKey()(Code) | | Get the name of this output element
the key of the output Element |
| getStyle | | public String getStyle()(Code) | | /**
Return the suggested "style" for displaying this Output item
A "style" string as suggested by the Controller |
| getUsedCount | | public long getUsedCount()(Code) | | the number of times this output has been used |
| hasNested | | public boolean hasNested(String nestedName) throws ControllerException(Code) | | Does this output have a nested item with the given name?
Parameters:
nestedName - The name to check against true if there is such an element, else false
throws:
ControllerException - upon error |
| incrementUsedCount | | public synchronized void incrementUsedCount()(Code) | | |
| setAlignment | | public synchronized void setAlignment(String newAlignment)(Code) | | Method used by the Controller to specify a suggested alignment
for this Output item
Parameters:
newAlignment - A String suggesting an alignment to the clientwhen displaying this Output item |
| setContent | | public synchronized void setContent(String newContent)(Code) | | Used by the Controller to specify the contents string of this Output
Parameters:
newContent - The new contents string |
| setDefaultValue | | public synchronized void setDefaultValue(String newContent)(Code) | | set contents; convenience method to unify Input/Output method names
Parameters:
newContent - The new contents string |
| setKey | | public synchronized void setKey(String newKey)(Code) | |
Parameters:
newKey - The new Key for the output |
| setStyle | | public synchronized void setStyle(String newStyle)(Code) | | Used by the Controller to set a suggested "style" for displaying this
Output item
Parameters:
newStyle - The new "style" to set for this output object |
| toXML | | public FastStringBuffer toXML(FastStringBuffer stream)(Code) | | Concert the object to an xml fragment.
Parameters:
stream - The fastStringBuffer to append to a FastStingBuffer object that represents this output in anxml fragment |
|
|
|