org.enhydra.barracuda.core.comp
Class BText

java.lang.Object
  |
  +--org.enhydra.barracuda.core.comp.AbstractBComponent
        |
        +--org.enhydra.barracuda.core.comp.BComponent
              |
              +--org.enhydra.barracuda.core.comp.BText
All Implemented Interfaces:
BContainer, StateMap

public class BText
extends BComponent

BText is used for rendering text into a DOM. You can bind it to just about any type of node, and it will do its best to put the text in the proper place.

In most cases you will not actually need to bind the component to a view in order to use it--if you return it from a model, this will be done for you automatically. If however, you intend to use the component standalone (ie. manually attaching it to a specific node in the DOM) or inline (ie. in a toString()), then you MUST BIND IT TO A VIEW before rendering, or an error will be generated.


Field Summary
protected  boolean allowMarkupInText
           
protected static org.apache.log4j.Logger logger
           
protected  java.lang.String text
           
 
Fields inherited from class org.enhydra.barracuda.core.comp.BComponent
attrs, CACHING_MARKER, enabled, name, rs, VISIBILITY_MARKER, visible
 
Fields inherited from class org.enhydra.barracuda.core.comp.AbstractBComponent
children, dvc, isStepChild, parent, preventCaching, statemap, stepChildren, tempViews, validated, views
 
Constructor Summary
BText()
          Public noargs constructor
BText(java.lang.String text)
          Public constructor which creates the component and sets the text.
 
Method Summary
 boolean allowMarkupInText()
          See if we allow markup in the text
 java.lang.String getText()
          Get the text for this particular component
 void setAllowMarkupInText(boolean val)
          Do we wish to allow markup in this text (defaults to false)
 void setText(java.lang.String itext)
          Set the text for this particular component
 java.lang.String toString()
          Get a String representation of the component
 
Methods inherited from class org.enhydra.barracuda.core.comp.BComponent
addView, getAttr, getAttrMap, getFirstView, getName, getRenderStrategy, getViews, isEnabled, isVisible, postRender, preRender, removeAllViews, removeView, render, render, renderView, renderView, setAttr, setEnabled, setEnabled, setName, setRenderStrategy, setView, setVisible, setVisible, supports
 
Methods inherited from class org.enhydra.barracuda.core.comp.AbstractBComponent
addChild, addStepChild, addStepChild, addTempView, destroyCycle, findComponentMap, findRendererFactory, getChild, getChildren, getDefaultViewContext, getParent, getPreventCaching, getRenderer, getRenderer, getRootComponent, getState, getStateKeys, getStateValues, hasChildren, hasViews, initCycle, installRendererFactory, invalidate, isStepChild, printStackTrace, printStackTrace, printStackTrace, putState, removeAll, removeAllStepChildren, removeChild, removeChild, removeState, setDefaultViewContext, setParent, setPreventCaching, toRef, toString, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

logger

protected static org.apache.log4j.Logger logger

text

protected java.lang.String text

allowMarkupInText

protected boolean allowMarkupInText
Constructor Detail

BText

public BText()
Public noargs constructor


BText

public BText(java.lang.String text)
Public constructor which creates the component and sets the text.

You should generally only use this constructor when returning BText from a Model, as the model components will automatically bind the component to a view for you. If you use this constructor in some other situation, you should manually bind the component to the proper view.

Parameters:
text - the text string that backs this component
Method Detail

setText

public void setText(java.lang.String itext)
Set the text for this particular component


getText

public java.lang.String getText()
Get the text for this particular component

Returns:
the text for this particular component

setAllowMarkupInText

public void setAllowMarkupInText(boolean val)
Do we wish to allow markup in this text (defaults to false)

Parameters:
val - true if we wish to allow markup in the text

allowMarkupInText

public boolean allowMarkupInText()
See if we allow markup in the text

Returns:
true if we wish to allow markup in the text

toString

public java.lang.String toString()
Get a String representation of the component

Overrides:
toString in class AbstractBComponent
Returns:
a String representation of the component


Copyright © 2001 Enhydra.org