Package lumis.doui.control.button

Class ButtonControl

java.lang.Object

lumis.doui.control.Control

lumis.doui.control.SourceBoundControl<Source<?>>

lumis.doui.control.button.ButtonControl

All Implemented Interfaces:

VariableResolver, IControl

Direct Known Subclasses:

AccessControlButton, AddButton2Control, AddButtonControl, CancelButtonControl, CloneDataButtonControl, ConfigureButtonControl, DeleteButtonControl, EditButton2Control, EditButtonControl, FollowButtonControl, GenerateContentButtonControl, LockButtonControl, OkButtonControl, PositionFieldOrderButtonControl, PreviewButtonControl, PrintButtonControl, PublishToSocialNetworkButtonControl, RefreshButtonControl, SaveAndPreviewButtonControl, StealLockButtonControl, ValidatorButton, VersionsButtonControl

public class ButtonControl
extends SourceBoundControl<Source<?>>

Defines a standard button control with text, image and onClick definition.

Example use: <control:lum_button id="sendTestEmail" text="STR_SEND_TEST_EMAIL"> <image>lumis/portal/client/images/EmailTest.gif</image> <onClick type="popupRunTimeInterface"> <interfaceId>sendTestEmail</interfaceId> <addParameters> <parameter name="bulletinId"> <value type="firstSelected" controlId="adminList.tabulardata"/> </parameter> </addParameters> <validators> <validator type="selectedOne" controlId="adminList.tabulardata"/> </validators> </onClick> </control:lum_button> xml data available for xsl rendering: <control id="sendTestEmail" text="STR_SEND_TEST_EMAIL" type="lum_button"> <image>lumis/portal/client/images/EmailTest.gif</image> <rowAction/> <onClick type="popupRunTimeInterface"> <interfaceId>sendTestEmail</interfaceId> <addParameters> <parameter name="bulletinId"> <value controlId="adminList.tabulardata" type="firstSelected"/> </parameter> </addParameters> <validators> <validator controlId="adminList.tabulardata" type="selectedOne"/> </validators> </onClick> <data> <name>Send test e-mail</name> <onclick><!-- javascript for onClick event --></onclick> </data> </control> Base button control implementation.

Since:

4.0.0

Version:

$Revision: 20877 $ $Date: 2018-01-09 11:44:08 -0200 (Tue, 09 Jan 2018) $

Field Summary

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, ON_EVENT_VALIDATE, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

Constructors

Constructor	Description
ButtonControl()

Method Summary

Modifier and Type	Method	Description
protected TabularDataControl	getAssociatedTabularDataControl()	Returns the tabular data control referenced (either explicitly or automatically detected) by this button for row actions or parameter value.
IResource	getControlResource()
protected java.lang.String	getDefaultPopupPageId(java.lang.String interfaceId)
java.lang.String	getScriptGetButtonText()
java.lang.String	getScriptSetButtonImageAlt(java.lang.String imgAlt)
java.lang.String	getScriptSetButtonText(java.lang.String buttonText)
java.lang.String	getText()
void	setRenderData()
void	setText(java.lang.String text)

Methods inherited from class lumis.doui.control.SourceBoundControl

getRuntimeDefaultSource, getSource, getSourceContext

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, buildSubControls, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, generateControlIdPrefix, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getName, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getStringsToLocalize, getType, getValidationScript, getWindowProperties, getWindowProperties, init, isRequired, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setName, setRuntimeAttributes, setValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ButtonControl

public ButtonControl()

Method Detail

getAssociatedTabularDataControl

protected TabularDataControl getAssociatedTabularDataControl()
                                                      throws PortalException

Returns the tabular data control referenced (either explicitly or automatically detected) by this button for row actions or parameter value. This method should be called only during setRenderData(), so all controls dynamically generated should already be existing.

Returns:

the tabular data control or null if none was found.

Throws:

PortalException

Since:

8.0.0

setRenderData

public void setRenderData()
                   throws PortalException

Specified by:

setRenderData in interface IControl

Overrides:

setRenderData in class Control

Throws:

PortalException

getControlResource

public IResource getControlResource()
                             throws PortalException

Specified by:

getControlResource in interface IControl

Overrides:

getControlResource in class Control

Throws:

PortalException

getDefaultPopupPageId

protected java.lang.String getDefaultPopupPageId(java.lang.String interfaceId)
                                          throws PortalException

Throws:

PortalException

getText

public java.lang.String getText()

setText

public void setText(java.lang.String text)

getScriptSetButtonText

public java.lang.String getScriptSetButtonText(java.lang.String buttonText)

getScriptSetButtonImageAlt

public java.lang.String getScriptSetButtonImageAlt(java.lang.String imgAlt)

getScriptGetButtonText

public java.lang.String getScriptGetButtonText()