org.barracudamvc.core.comp
Class BLink

java.lang.Object
  extended by org.barracudamvc.core.comp.AbstractBComponent
      extended by org.barracudamvc.core.comp.BComponent
          extended by org.barracudamvc.core.comp.BAction
              extended by org.barracudamvc.core.comp.BLink
All Implemented Interfaces:
Attrs, BContainer, StateMap

public class BLink
extends BAction

BLink is used to manipulate any element in a DOM template that is capable of generating a URL request. In the case of HTML, this would typically include <a>, <input>, and <button> elements.

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.

Because BLink may often be used for inling, it includes constructors that conveniently allow you to specify the a ViewContext (ie. instead of an actual View)


Field Summary
protected  boolean allowMarkupInText
           
protected static org.apache.log4j.Logger logger
           
protected  String target
           
protected  String text
           
 
Fields inherited from class org.barracudamvc.core.comp.BAction
actionEvent, actionUrl, disableBackButton, disableFormLocking, listeners, params, scriptFunctions
 
Fields inherited from class org.barracudamvc.core.comp.BComponent
DEFAULT_ENCODING, enabled, enc, name, rs, VISIBILITY_MARKER, visible
 
Fields inherited from class org.barracudamvc.core.comp.AbstractBComponent
attrs, children, dvc, isStepChild, parent, statemap, stepChildren, tempViews, validated, views
 
Constructor Summary
BLink()
          Public noargs constructor
BLink(String itext)
          Public constructor which creates the component and sets the text, and target values.
BLink(String itext, ControlEvent iactionEvent)
          Public constructor which creates the component and sets the text and action values.
BLink(String itext, ControlEvent iactionEvent, ViewContext idvc)
          Public constructor which creates the component and sets the text and action values.
BLink(String itext, String iactionUrl)
          Public constructor which creates the component and sets the text and action values.
BLink(String itext, String iactionUrl, ViewContext idvc)
          Public constructor which creates the component and sets the text and action values.
 
Method Summary
 boolean allowMarkupInText()
          See if we allow markup in the text
 String getTarget()
          Get the target for this particular component
 String getText()
          Get the text for this particular component
 BLink setAllowMarkupInText(boolean val)
          Do we wish to allow markup in this text (defaults to false)
 BLink setTarget(String itarget)
          Set the target for this particular component
 BLink setText(String itext)
          Set the text for this particular component
 String toString(ViewContext vc)
          if has vc, but no views: render as an <a> link, otherwise use super.toString(ViewContext)
 
Methods inherited from class org.barracudamvc.core.comp.BAction
addEventListener, addScriptFunction, getAction, getAction, getDisableBackButton, getDisableFormLocking, getParams, getScriptFunctions, hasAction, removeEventListener, setAction, setAction, setDisableBackButton, setDisableFormLocking, setParam, setParam
 
Methods inherited from class org.barracudamvc.core.comp.BComponent
addView, decodeStr, encodeStr, getEncoding, getFirstView, getName, getRenderStrategy, getViews, isEnabled, isVisible, postRender, preRender, removeAllViews, removeView, render, render, renderView, renderView, setEnabled, setEnabled, setEncoding, setName, setRenderStrategy, setView, setVisible, setVisible, supports
 
Methods inherited from class org.barracudamvc.core.comp.AbstractBComponent
addChild, addStepChild, addStepChild, addTempView, clearState, destroyCycle, findComponentMap, findRendererFactory, getAttr, getAttrMap, getChild, getChildren, getDefaultViewContext, getParent, getRenderer, getRenderer, getRendererFactory, getRootComponent, getState, getStateKeys, getStateStore, hasChildren, hasViews, initCycle, installRendererFactory, invalidate, isStepChild, printStackTrace, printStackTrace, printStackTrace, putState, removeAll, removeAllStepChildren, removeChild, removeChild, removeState, setAttr, setDefaultViewContext, setParent, 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 final org.apache.log4j.Logger logger

text

protected String text

target

protected String target

allowMarkupInText

protected boolean allowMarkupInText
Constructor Detail

BLink

public BLink()
Public noargs constructor


BLink

public BLink(String itext)
Public constructor which creates the component and sets the text, and target values. This link will fire the default action event (unless you manually specify an action).

Parameters:
itext - the text string that backs this component

BLink

public BLink(String itext,
             String iactionUrl)
Public constructor which creates the component and sets the text and action values.

Parameters:
itext - the text string that backs this component
iactionUrl - the action url to be fired (opt--if null, the default action specified in the template will be fired)

BLink

public BLink(String itext,
             String iactionUrl,
             ViewContext idvc)
Public constructor which creates the component and sets the text and action values. This constructor takes a ViewContext object which will be used to create a default view for the component (ie. use this constructor for inling a BLink)

Parameters:
itext - the text string that backs this component
iactionUrl - the action url to be fired (opt--if null, the default action specified in the template will be fired)
idvc - the default ViewContext (opt--its presence allows the component to be rendered as markup in toString())

BLink

public BLink(String itext,
             ControlEvent iactionEvent)
Public constructor which creates the component and sets the text and action values.

Parameters:
itext - the text string that backs this component
iactionEvent - the action event to be fired (opt--if null, the default ActionEvent will be fired)

BLink

public BLink(String itext,
             ControlEvent iactionEvent,
             ViewContext idvc)
Public constructor which creates the component and sets the text and action values. This constructor takes a ViewContext object which will be used to create a default view for the component (ie. use this constructor for inling a BLink)

Parameters:
itext - the text string that backs this component
iactionEvent - the action event to be fired (opt--if null, the default ActionEvent will be fired)
idvc - the default ViewContext (opt--its presence allows the component to be rendered as markup in toString())
Method Detail

setText

public BLink setText(String itext)
Set the text for this particular component

Parameters:
itext - the text representation of this component

getText

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

Returns:
the text for this particular component

setTarget

public BLink setTarget(String itarget)
Set the target for this particular component

Parameters:
itarget - the ext representation of the target

getTarget

public String getTarget()
Get the target for this particular component

Returns:
the target for this particular component

setAllowMarkupInText

public BLink 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 String toString(ViewContext vc)
if has vc, but no views: render as an <a> link, otherwise use super.toString(ViewContext)

Overrides:
toString in class AbstractBComponent
Returns:
a String representation of the component
See Also:
super#toString(ViewContext)


Copyright © 2006 BarracudaMVC.org All Rights Reserved.