Update of
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/src/main/java/org/xdoclet/plugin/tapestry/qtags
In directory
sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16371/xdoclet-plugins/plugin-tapestry/src/main/java/org/xdoclet/plugin/tapestry/qtags
Modified Files:
TacosTreeTag.java
Added Files:
TacosAjaxDirectLinkTag.java TacosAjaxFieldObserverTag.java
TacosAjaxFormTag.java TacosAjaxLinkSubmitTag.java
TacosAjaxSubmitTag.java TacosAutocompleterTag.java
TacosDatePickerTag.java TacosDialogTag.java
TacosDirtyFormWarningTag.java TacosDropTargetTag.java
TacosEditorTag.java TacosFisheyeListTag.java
TacosFloatingPaneTag.java TacosInlineEditBoxTag.java
TacosPaletteTag.java TacosPartialForTag.java
TacosProgressBarTag.java TacosRefreshTag.java
TacosSiteMapTag.java
Log Message:
Added @tacos.* tags. They provide Ajax features to tapestry
--- NEW FILE: TacosEditorTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
*Listener will be invoked with first parameter being the new value that was
selected.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosEditorTag extends com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Listener will be invoked with first parameter being the new value that
was selected.
*
*/
String getListener();
/**
* Whether or not the request created by this component should be required
to be stateful or not, default is false.
*
*/
String getStateful();
/**
* Specifies whether or not to do a direct service call for component.
* This will improve the performance of the call dramatically, but will
probably produce tons of exceptions and problems if component is embedded in
other components.
*
*/
String getDirect();
/**
* The toolbar items to include in the editor.
*
*/
String getItems();
/**
* The element to emulate.
*
*/
String getElement();
/**
* The tag used to add this component in a template.
*
*/
String getTemplateTag();
/**
* No description available yet.
*
*
* @qtags.required
*/
String getValue_();
/**
* No description available yet.
*
*/
String getDisabled();
}
--- NEW FILE: TacosDatePickerTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
[EMAIL PROTECTED]: ADD COMPONENT DESCRIPTION
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosDatePickerTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* No description available yet.
*
*
* @qtags.required
*/
String getValue_();
/**
* No description available yet.
*
*/
String getDisabled();
/**
* No description available yet.
*
*/
String getIncludeWeek();
/**
* No description available yet.
*
*/
String getIcon();
/**
* No description available yet.
*
*/
String getDisplayName();
/**
* No description available yet.
*
*/
String getTranslator();
/**
* No description available yet.
*
*/
String getValidators();
/**
* No description available yet.
*
*/
String getHtmlid();
}
--- NEW FILE: TacosDropTargetTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Provides drag and drop functionality
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosDropTargetTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Defines the html element tag types that this drop target accepts when
dragged into it.
* The default is '*', which accepts any elements.
* To be able to interact with multiple drop targets on a page it may be
neccesary to filter the allowed list to something like 'li', 'div' to prevent
some targets.
*
*/
String getAcceptsTagType();
/**
* Object,String[],Collection of component/element ids (the rendered html
must contain an id= attribute for them to be collected properly) to make
draggable into this drop target area.
*
*/
String getDragSource();
/**
* If specified, used to add draggable sources by iterating over the child
nodes of the specified source element.
* If dragSourceClass or dragSourceTag aren't specified for selecting child
nodes then div tag type is used by default.
* It is very important to specify an "id" attribute on these nodes,
otherwise the drag target won't have any way to identify them when trying to
invoke the dragSourceAction.
* (If that's important for your purposes.
* )
*/
String getDragSourceElement();
/**
* Used in conjunction with dragSourceElement to select all child nodes
that have a class name matching dragSourceClass.
*
*/
String getDragSourceClass();
/**
* Used in conjunction with dragSourceElement to select all child nodes
that have a tag type matching dragSourceTag.
*
*/
String getDragSourceTag();
/**
* Specifies the action to take when a draggable source is dropped into
this dropTarget using an AjaxDirectLink component.
* The unique id of the dragged source object will be appended to whatever
AjaxDirectLink url is specified here.
* If a node iterated via dragSourceElement does not have an id attribute
it won't be added as a draggable source.
* The parameterName of the links selected draggable source will be
dragSourceId.
*
*
* @qtags.required
*/
String getDragSourceLink();
/**
* Specifies whether or not to allow the dragged source html elements to be
inserted into the DropTarget.
*
*/
String getInsertDragSource();
/**
* If specified, the javascript specified here will be executed when drag
source objects are dragged over the drop target.
* The event passed in has a special attribute, dragObject which is the
source of the drag.
* Useful for performing effects on drop target, like changing the
background color.
*
*/
String getOnDragOver();
/**
* If specified, the javascript specified here will be executed when drag
source objects are dragged out of the drop target.
* The event passed in has a special attribute, dragObject which is the
source of the drag.
* Useful for performing effects on drop target, like changing the
background color.
*
*/
String getOnDragOut();
/**
* If specified, the javascript specified here will be executed when drag
source objects are dropped into the drop target.
* The event passed in has a special attribute, dragObject which is the
source of the drag.
* Overriding this parameter won't have any affect on insertDragSource.
*
*/
String getOnDrop();
}
--- NEW FILE: TacosDialogTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Dialog display of content.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosDialogTag extends com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* No description available yet.
*
*/
String getHidden();
}
--- NEW FILE: TacosAjaxSubmitTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Creates a labeled submit button within a form.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosAjaxSubmitTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Deprecated in 4.
*0.
* An alternate way to specify the value attribute, which is the label used
on the button in the browser (as well as the value supplied in the query
parameter on form submit).
*
*/
String getLabel();
/**
* If true, then the component is disabled, which will be reflected in the
output submit element.
* Additionally, the component will not respond during the form submission.
*
*/
String getDisabled();
/**
* If bound, then this parameter will be updated with the value of the tag
parameter, if the Submit is triggered.
*
*/
String getSelected();
/**
* A tag value used to identify this Submit as the triggered component.
*
*/
String getTag();
/**
* A listener that is notified if this component is triggered.
*
*/
String getListener();
/**
* A listener that is notified if this component is triggered just before
the form's listener, after all components enclosed by the Form have had a
chance to update their properties.
*
*/
String getAction();
/**
* An object, or list of objects, gathered when the button is triggered
and made available as listener parameters in the request cycle, making the
parameters available to a deferred listener.
*
*/
String getParameters_();
/**
* Collection/list of component id strings to refresh after invoking
listener.
*
*/
String getUpdateComponents();
/**
* Provides ability to have the action encapsulated by the specified
AjaxDirectLink used when users hit back button on browser.
*
*/
String getBackLink();
/**
* Provides ability to have the action encapsulated by the specified
AjaxDirectLink used when users hits forward button on browser AFTER hitting
back button provided in backLink first.
*
*/
String getForwardLink();
/**
* If specified, the string passed in will be used to build a javascript
statement which will call updateObject.
*ajaxUpdate(element, responseElement, elementId).
*
*/
String getUpdateObject();
/**
* Specifies effects that should be performed on parts in the returned
ajax response.
* the effects should be accepted by tacos.
*js
*/
String getEffects();
/**
* If specified, and updateStatus is set, updates the contents of the
specified html element in the page with the status text.
*
*/
String getStatusElement();
/**
* No description available yet.
*
*/
String getHtmlid();
}
Index: TacosTreeTag.java
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/src/main/java/org/xdoclet/plugin/tapestry/qtags/TacosTreeTag.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** TacosTreeTag.java 24 Oct 2005 12:23:30 -0000 1.1
--- TacosTreeTag.java 9 Dec 2005 14:44:15 -0000 1.2
***************
*** 1,3 ****
! /*
* Copyright (c) 2003-2005
* XDoclet Team
--- 1,3 ----
! /**
* Copyright (c) 2003-2005
* XDoclet Team
***************
*** 7,15 ****
/**
! * Tree component.
* Works similar to a Foreach: the body is rendered for every element.
! * The current element can be accessed via the outgoing binding "value". This
! * component is partial request compatible, meaning that if you invoke
PartialLink's
! * with refreshParts containing unique tree node id's it will render them
correctly.
*
* @qtags.location class
--- 7,15 ----
/**
! *Tree component.
* Works similar to a Foreach: the body is rendered for every element.
! * The current element can be accessed via the outgoing binding "value".
! * This component is partial request compatible, meaning that if you invoke
PartialLink's with refreshParts containing unique tree node id's it will render
them correctly.
! *
*
* @qtags.location class
***************
*** 25,28 ****
--- 25,30 ----
/**
* Provides elements for tree to display.
+ *
+ *
* @qtags.required
*/
***************
*** 32,47 ****
* Converter from elements to keys.
* Optional, by default IdentityKeyProvider is used.
*/
String getKeyProvider();
!
/**
* Outgoing binding to current value.
* @qtags.required
*/
String getValue_();
!
/**
* Set of currently open element keys.
* Optional, by default an empty persistent HashSet is created.
*/
String getState();
--- 34,59 ----
* Converter from elements to keys.
* Optional, by default IdentityKeyProvider is used.
+ *
*/
String getKeyProvider();
!
! /**
! * Provides ability to specify a tapestry IPrimaryKeyConverter to the
tree.
! *
! */
! String getConverter();
!
/**
* Outgoing binding to current value.
+ *
+ *
* @qtags.required
*/
String getValue_();
!
/**
* Set of currently open element keys.
* Optional, by default an empty persistent HashSet is created.
+ *
*/
String getState();
***************
*** 49,52 ****
--- 61,65 ----
/**
* Optional comparator to order the displayed elements by.
+ *
*/
String getSorter();
***************
*** 54,78 ****
/**
* Offset in pixels for depth-indentation.
*/
String getOffset();
!
/**
! * If provided the individual rows of the tree will alternate styles using
! * the provided EvenOdd beans even and odd css classes.
*/
String getRowStyle();
!
/**
! * Optional, if specified the surrounding div block on each category or
node
! * will have its class attribute set to this value
*/
String getPartialBlockClass();
!
/**
! * Specifies the listener to invoke during the execution of
contentExpansion method.
! * This enables other components to cause the tree to collapse/expand
nodes on the tree AND
! * invoke their listeners. It's basically a work around for being able to
specify multiple listeners
! * on a link.
*/
String getLinkListener();
! }
\ No newline at end of file
--- 67,128 ----
/**
* Offset in pixels for depth-indentation.
+ *
*/
String getOffset();
!
/**
! * If provided the individual rows of the tree will alternate styles
using the provided EvenOdd beans even and odd css classes.
! *
*/
String getRowStyle();
!
/**
! * Optional, if specified the surrounding div block on each category or
node will have its class attribute set to this value
*/
String getPartialBlockClass();
!
/**
! * Specifies the listener to invoke during the execution of
contentExpansion method.
! * This enables other components to cause the tree to collapse/expand
nodes on the tree AND invoke their listeners.
! * It's basically a work around for being able to specify multiple
listeners on a link.
! *
*/
String getLinkListener();
!
! /**
! * If specified, overrides the default open node + icon used on tree.
! *
! */
! String getOpenIcon();
!
! /**
! * If specified, overrides the default close node - icon used on tree.
! *
! */
! String getCloseIcon();
!
! /**
! * Allows specifying whether or not the +/- links on a node are invoked
via ajax or normal http requests.
! * Default is ajax.
! *
! */
! String getNodeLinkAjax();
!
! /**
! * Can only be used if javascript/ajax is enabled in your browser
environment, if specified the trees contents won't be displayed when being
loaded by a window, but will instead be replaced with a default "Loading.
! *.
! *" text element (replaceable by using the loadElement parameter) while
an additional ajax request is made after the window.
! *onload event is fired to get the trees contents.
! *
! */
! String getDelayedLoad();
!
! /**
! * If delayedLoad=true, this element will be placed relatively in the
center of the tree's content area during delayed loads instead of the default
"Loading.
! *.
! *" text.
! *
! */
! String getLoadElement();
!
! }
--- NEW FILE: TacosAjaxFormTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Used to implement an HTML form in ajax requests.
* Warning!! Not for production use.
* There are still a lot of javascript related things that need to be fixed
before this component will be usable.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosAjaxFormTag extends com.thoughtworks.qdox.model.DocletTag
{
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Collection/list of component id strings to refresh after invoking
listener.
*
*/
String getUpdateComponents();
/**
* Provides ability to have the action encapsulated by the specified
AjaxDirectLink used when users hit back button on browser.
*
*/
String getBackLink();
/**
* Provides ability to have the action encapsulated by the specified
AjaxDirectLink used when users hits forward button on browser AFTER hitting
back button provided in backLink first.
*
*/
String getForwardLink();
/**
* If specified, the string passed in will be used to build a javascript
statement which will call updateObject.
*ajaxUpdate(element, responseElement, elementId).
*
*/
String getUpdateObject();
/**
* Specifies effects that should be performed on parts in the returned ajax
response.
* the effects should be accepted by tacos.
*js
*/
String getEffects();
/**
* If specified, and updateStatus is set, updates the contents of the
specified html element in the page with the status text.
*
*/
String getStatusElement();
/**
* The method used by the form when it is submitted, defaults to "post".
*
*/
String getMethod();
/**
* Object invoked when the form is submitted normally (not a cancel or a
refresh) and the validation delegate contains no errors.
*
*/
String getSuccess();
/**
* Object invoked when the form is cancelled (a special type of form
submission).
* The cancel listener (if any) overrides the standard listener.
* Other properties will not be affected by the rewind.
*
*/
String getCancel();
/**
* Object invoked when the form is refreshed (a special type of form
submission).
* The refresh listener (if any) overrides the standard listener.
* Other properties managed by enclosed components will be updated.
*
*/
String getRefresh();
/**
* Default listener used when no other listener is invoked.
*
*/
String getListener();
/**
* If true (the default), then an active session is required when the form
is submitted, if there was an active session when the form was rendered.
*
*/
String getStateful();
/**
* If true (the default), then the more efficient direct service is used.
* If false, then the action service is used.
*
*/
String getDirect();
/**
* Specifies the delegate to be used by fields to track input errors.
* If not specified, the Form provides a default instance of org.
*apache.
*tapestry.
*valid.
*ValidationDelegate.
*
*/
String getDelegate();
/**
* If true (the default) then client-side validation will be generated
upon render for any required or validating fields.
*
*/
String getClientValidationEnabled();
/**
* If true (the default), then the form will attempt to get field focus on
the first field in error (or first required field, or just first field) within
the form.
* Set to false to allow a different Form on the same page to claim field
focus.
*
*/
String getFocus();
}
--- NEW FILE: TacosAjaxFieldObserverTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
*Derivative of DirectLink with support for ajax requests.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosAjaxFieldObserverTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Collection/list of component id strings to refresh after invoking
listener.
*
*/
String getUpdateComponents();
/**
* Collection/list of html block ids to refresh after invoking listener.
*
*/
String getUpdateBlocks();
/**
* If specified, the string passed in will be used to build a javascript
statement which will call updateObject.
*ajaxUpdate(element, responseElement, elementId).
*
*/
String getUpdateObject();
/**
* A listener that is notified if this component is triggered.
*
*/
String getListener();
/**
* A listener that is notified if this component is triggered just before
the form's listener, after all components enclosed by the Form have had a
chance to update their properties.
*
*/
String getAction();
/**
* An object, or list of objects, gathered when the button is triggered
and made available as listener parameters in the request cycle, making the
parameters available to a deferred listener.
*
*/
String getParameters_();
/**
* Specifies whether or not components should be invoked directly.
* This will cause the engine service to only call renderComponent on the
targeted components of this request, whereas normal behaviour is to render the
whole page and only return the portions of the response that were requested.
* Use at your own risk, components contained by lists, like Foreach and
For will likely not be directly updateable.
*
*/
String getDirect();
/**
* Specifies effects that should be performed on parts in the returned ajax
response.
* the effects should be accepted by tacos.
*js
*/
String getEffects();
/**
* If specified, and updateStatus is set, updates the contents of the
specified html element in the page with the status text.
*
*/
String getStatusElement();
/**
* No description available yet.
*
*/
String getHtmlid();
/**
* No description available yet.
*
*/
String getStateful();
/**
* No description available yet.
*
*/
String getDisabled();
/**
* No description available yet.
*
*/
String getAnchor();
/**
* No description available yet.
*
*/
String getRenderer();
}
--- NEW FILE: TacosFloatingPaneTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Provides FloatingPane functionality
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosFloatingPaneTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* No description available yet.
*
*/
String getMinHeight();
/**
* No description available yet.
*
*/
String getMinWidth();
/**
* No description available yet.
*
*/
String getHasShadow();
/**
* No description available yet.
*
*/
String getHasToolbar();
/**
* No description available yet.
*
*/
String getTitle();
/**
* No description available yet.
*
*/
String getStyle();
}
--- NEW FILE: TacosPaletteTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* A complex component used to manage multiple selection of items from a list.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosPaletteTag extends com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* No description available yet.
*
*/
String getSelectedTitleBlock();
/**
* No description available yet.
*
*/
String getAvailableTitleBlock();
/**
* No description available yet.
*
*
* @qtags.required
*/
String getModel();
/**
* No description available yet.
*
*
* @qtags.required
*/
String getSelected();
/**
* No description available yet.
*
*/
String getSort();
/**
* No description available yet.
*
*/
String getRows();
/**
* No description available yet.
*
*/
String getTableClass();
/**
* No description available yet.
*
*/
String getSelectImage();
/**
* No description available yet.
*
*/
String getDisabledImage();
/**
* No description available yet.
*
*/
String getDeselectImage();
/**
* No description available yet.
*
*/
String getSelectDisabledImage();
/**
* No description available yet.
*
*/
String getDeselectDisabledImage();
/**
* No description available yet.
*
*/
String getUpImage();
/**
* No description available yet.
*
*/
String getUpDisabledImage();
/**
* No description available yet.
*
*/
String getDownImage();
/**
* No description available yet.
*
*/
String getDownDisabledImage();
/**
* No description available yet.
*
*/
String getDisplayName();
/**
* No description available yet.
*
*/
String getHtmlid();
/**
* No description available yet.
*
*/
String getValidators();
}
--- NEW FILE: TacosAutocompleterTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Provides Autocompleter functionality for TextField components.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosAutocompleterTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Object,String[],Collection of values to be used to autocomplete a
particular autocomplete field search, this should be set when this component
invokes your input search listener.
*
*
* @qtags.required
*/
String getListSource();
/**
* Listener method to invoke for each field search request.
* This listener should expect to get exactly one paramter of type String,
which is the value that the request is searching on.
*
*
* @qtags.required
*/
String getListener();
/**
* Whether or not the request created by this component should be required
to be stateful or not, default is false.
*
*/
String getStateful();
/**
* Specifies whether or not to do a direct service call for component.
* This will improve the performance of the call dramatically, but will
probably produce tons of exceptions and problems if component is embedded in
other components.
*
*/
String getDirect();
/**
* The ListItemRenderer that should be used to render the drop down list,
the default renderer iterates over the values and puts the string value in a
<li></li> block.
*
*/
String getListItemRenderer();
/**
* The class to use to render the drop down list.
*
*/
String getElementclass();
/**
* No description available yet.
*
*
* @qtags.required
*/
String getValue_();
/**
* No description available yet.
*
*/
String getDisabled();
/**
* No description available yet.
*
*/
String getDisplayName();
/**
* No description available yet.
*
*/
String getTranslator();
/**
* No description available yet.
*
*/
String getValidators();
/**
* No description available yet.
*
*/
String getHtmlid();
}
--- NEW FILE: TacosFisheyeListTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* A fisheye list for interacting with icon components
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosFisheyeListTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* No description available yet.
*
*/
String getItemWidth();
/**
* No description available yet.
*
*/
String getItemHeight();
/**
* No description available yet.
*
*/
String getItemMaxWidth();
/**
* No description available yet.
*
*/
String getItemMaxHeight();
/**
* No description available yet.
*
*/
String getOrientation();
/**
* No description available yet.
*
*/
String getEffectUnits();
/**
* No description available yet.
*
*/
String getItemPadding();
/**
* No description available yet.
*
*/
String getAttachEdge();
/**
* No description available yet.
*
*/
String getLabelEdge();
/**
* No description available yet.
*
*/
String getBreakOn();
/**
* No description available yet.
*
*
* @qtags.required
*/
String getSource();
/**
* No description available yet.
*
*/
String getValue_();
/**
* No description available yet.
*
*/
String getIndex();
}
--- NEW FILE: TacosAjaxDirectLinkTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Generates a javascript function that submits the containing form using an
AJAX request.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosAjaxDirectLinkTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Collection/list of component id strings to refresh after invoking
listener.
*
*/
String getUpdateComponents();
/**
* Collection/list of html block ids to refresh after invoking listener.
*
*/
String getUpdateBlocks();
/**
* If specified, the string passed in will be used to build a javascript
statement which will call updateObject.
*ajaxUpdate(element, responseElement, elementId).
*
*/
String getUpdateObject();
/**
* An optional listener (typically specified as the name of a listener
method), notified when the component is triggered.
*
*/
String getListener();
/**
* A listener that is notified if this component is triggered just before
the form's listener, after all components enclosed by the Form have had a
chance to update their properties.
*
*/
String getAction();
/**
* Parameter(s) gathered at the time the button is triggered, supplied as
listener parameters in the IRequestCycle available to the listener.
* If the parameter is a Collection, it will be converted to an Object
array (to match the IRequestCycle getListenerParameters() signature).
* Allows listeners provided by the 'action' parameter to access any
rewinded state not conveniently placed using tag/selected (e.
*g.
* when there are multiple objects to select as might happen with a nested
For).
*
*/
String getParameters_();
/**
* Specifies whether or not components should be invoked directly.
* This will cause the engine service to only call renderComponent on the
targeted components of this request, whereas normal behaviour is to render the
whole page and only return the portions of the response that were requested.
* Use at your own risk, components contained by lists, like Foreach and
For will likely not be directly updateable.
*
*/
String getDirect();
/**
* Specifies effects that should be performed on parts in the returned
ajax response.
* The effects should be accepted by tacos.
*js.
*
*/
String getEffects();
/**
* Specifies effects that should be performed on parts before ajax request.
* The effects should be accepted by tacos.
*js.
*
*/
String getPreEffects();
/**
* If specified, and updateStatus is set, updates the contents of the
specified html element in the page with the status text.
*
*/
String getStatusElement();
/**
* If specified, updates the contents will be shown in a floating pane.
* and here specify FloatingPane used parameter and some tacos parameter.
*
*/
String getPopup();
/**
* No description available yet.
*
*/
String getStateful();
/**
* No description available yet.
*
*/
String getDisabled();
/**
* No description available yet.
*
*/
String getHtmlid();
/**
* No description available yet.
*
*/
String getAnchor();
/**
* No description available yet.
*
*/
String getRenderer();
}
--- NEW FILE: TacosAjaxLinkSubmitTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Creates a hyperlink that submits its enclosing form using JavaScript.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosAjaxLinkSubmitTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* A listener that is notified if this component is triggered.
*
*/
String getListener();
/**
* A listener that is notified if this component is triggered just before
the form's listener, after all components enclosed by the Form have had a
chance to update their properties.
*
*/
String getAction();
/**
* An object, or list of objects, gathered when the link is triggered and
made available as listener parameters in the request cycle, making the
parameters available to a deferred listener.
*
*/
String getParameters_();
/**
* Collection/list of component id strings to refresh after invoking
listener.
*
*/
String getUpdateComponents();
/**
* Provides ability to have the action encapsulated by the specified
AjaxDirectLink used when users hit back button on browser.
*
*/
String getBackLink();
/**
* Provides ability to have the action encapsulated by the specified
AjaxDirectLink used when users hits forward button on browser AFTER hitting
back button provided in backLink first.
*
*/
String getForwardLink();
/**
* If specified, the string passed in will be used to build a javascript
statement which will call updateObject.
*ajaxUpdate(element, responseElement, elementId).
*
*/
String getUpdateObject();
/**
* Specifies effects that should be performed on parts in the returned
ajax response.
* the effects should be accepted by tacos.
*js
*/
String getEffects();
/**
* If specified, and updateStatus is set, updates the contents of the
specified html element in the page with the status text.
*
*/
String getStatusElement();
/**
* No description available yet.
*
*/
String getDisabled();
/**
* No description available yet.
*
*/
String getSelected();
/**
* No description available yet.
*
*/
String getTag();
/**
* No description available yet.
*
*/
String getHtmlid();
}
--- NEW FILE: TacosDirtyFormWarningTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
*Warns user before leaving the page if there are changes to a Form.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosDirtyFormWarningTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* The Form component to track changes in.
*
*
* @qtags.required
*/
String getForm();
/**
* Warning message to display when form is dirty.
*
*/
String getMessage();
/**
* If true, always display warning.
*
*/
String getForceWarning();
}
--- NEW FILE: TacosProgressBarTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Used in conjunction with ProgressWorker to dynamically render the status and
progress of a server invoked thread.
* This component does not work without javascript.
* Most of the html for this component is rendered using floating divs and a
set of classes.
* There is a ProgressBar.
*css file included in the distribution that provides a good set of default
values already.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosProgressBarTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* The number of seconds the client-side javascript will wait before
refreshing the component
*/
String getReloadseconds();
/**
* This is the maximum number of characters the managed ProgressWorker's
statusString value can contain before the component truncates the value by
appending .
*.
*.
* to the end of the string.
*
*/
String getTruncateLength();
/**
* The ProgressWorker that this component is displaying the status of.
*
*/
String getWorker();
/**
* The html element to wrap the body with, default is div.
*
*/
String getElement();
/**
* If provided, the javascript object with the specified name will be
invoked with a method name of progressFinished(elementId).
* Ie progressComplete.
*progressFinished(elementId)
*/
String getOnCompleteObject();
}
--- NEW FILE: TacosRefreshTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Creates javascript refresh requests, similar to DirectLink, only this
component creates the javascript without a link.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosRefreshTag extends com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Collection/list of component id strings to refresh after invoking
listener.
*
*/
String getUpdateComponents();
/**
* Collection/list of html block ids to refresh after invoking listener.
*
*/
String getUpdateBlocks();
/**
* If specified, the string passed in will be used to build a javascript
statement which will call updateObject.
*ajaxUpdate(element, responseElement, elementId).
*
*/
String getUpdateObject();
/**
* Specifies whether or not components should be invoked directly.
* This will cause the engine service to only call renderComponent on the
targeted components of this request, whereas normal behaviour is to render the
whole page and only return the portions of the response that were requested.
* Use at your own risk, components contained by lists, like Foreach and
For will likely not be directly updateable.
*
*/
String getDirect();
}
--- NEW FILE: TacosPartialForTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Loops over a collection of source values.
* May also emulate an element (like an Any component).
* If this component is placed in a Form, it will automatically store the
collection in Hidden fields so that the structure of the page is preserved
during a rewind even if the values in the source change.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosPartialForTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* The source of values, a Java collection or array.
*
*
* @qtags.required
*/
String getSource();
/**
* If provided, the parameter is updated with the current value on each
iteration.
*
*/
String getValue_();
/**
* If provided, the parameter is updated with the index of the loop on
each iteration.
*
*/
String getIndex();
/**
* If provided, the component wraps its content with the requested element.
* Informal parameters become attributes of that element.
*
*/
String getElement();
/**
* Only active in a form.
* An OGNL expression that returns the primary key of the iterated value.
* The primary keys are stored in hidden fields during rendering and are
loaded from the form during a rewind to ensure that the iterations remain the
same.
* This is a simpler, but a less efficient alternative of the 'converter'
parameter.
* If needed, please use in conjuction with 'fullSource' to reference
objects not currently present in 'source'.
* Also, use the 'defaultValue' parameter to define the object to be
returned if a value corresponding to a particular primary key cannot be found.
*
*/
String getKeyExpression();
/**
* Only active in a form and in combination with the 'keyExpression'
parameter.
* If an object corresponding to a primary key stored in the form cannot be
found in the 'source' parameter, then the objects provided by this parameter
are searched for a match next.
*
*/
String getFullSource();
/**
* Only active in a form.
* The value to be used when no match for a given primary key is found.
*
*/
String getDefaultValue();
/**
* Only active in a form.
* Defines how the items iterated upon will be stored in the form as hidden
values and how the stored information will be converted back to objects.
* This interface allows only the primary key of the items to be stored,
rather than the whole item.
*
*/
String getConverter();
/**
* Only active in a form.
* If provided, the parameter is automatically updated before a rewind with
the list of primary keys stored in the form.
* The parameter is updated right before the iterations begin in a rewind
and could be used to preload the relevant objects in the provided 'converter'.
*
*/
String getPrimaryKeys();
/**
* Tacos compliant IKeyProvider key provider.
*
*/
String getKeyProvider();
/**
* Only active in a form.
* This parameter allows the matching of the squeezed representation of the
values with that of the values in 'source'.
* It guarantees that the values iterated upon are physically identical to
the ones provided.
* The method is often slower than simple unsqueezing, but it eliminates a
number of potential pitfalls.
* Please disable with caution.
*
*/
String getMatch();
/**
* Only active in a form.
* Determines whether to avoid creating hidden fields within a form.
* Using this parameter may make the form structure different during render
and rewind, and cause exceptions as a result.
* Please use with caution.
*
*/
String getVolatile();
/**
* The PartialRenderBlock service that will provide a valid IMarkupWriter
to the loop iteration if the contents of the loop should be partially rendered,
even if the partId of the contents isn't specifically in the part request.
*
*/
String getPartialBlock();
/**
* If provided, will increment evenOdd bean on each iteration of loop.
*
*/
String getEvenOdd();
}
--- NEW FILE: TacosInlineEditBoxTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
* Provides in-line editing of text values.
*
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosInlineEditBoxTag extends
com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
/**
* Listener will be invoked with first parameter being the new value that
was selected.
*
*/
String getListener();
/**
* Whether or not the request created by this component should be required
to be stateful or not, default is false.
*
*/
String getStateful();
/**
* Specifies whether or not to do a direct service call for component.
* This will improve the performance of the call dramatically, but will
probably produce tons of exceptions and problems if component is embedded in
other components.
*
*/
String getDirect();
/**
* No description available yet.
*
*
* @qtags.required
*/
String getValue_();
}
--- NEW FILE: TacosSiteMapTag.java ---
/**
* Copyright (c) 2003-2005
* XDoclet Team
* All rights reserved.
*/
package org.xdoclet.plugin.tapestry.qtags;
/**
[EMAIL PROTECTED]: ADD COMPONENT DESCRIPTION
*
* @qtags.location class
* @author Paolo Dona
*/
public interface TacosSiteMapTag extends com.thoughtworks.qdox.model.DocletTag {
/**
* The id of the component
* @qtags.required
*/
String getId();
}
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click
_______________________________________________
xdoclet-plugins-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xdoclet-plugins-commits
