Package overit.geocall.basic.ui.control

Class TaskBoxMenu

java.lang.Object

overit.geocall.platform.ui.UINode

overit.geocall.ui.Component

overit.geocall.ui.Control

overit.geocall.basic.ui.control.TaskBox

overit.geocall.basic.ui.control.TaskBoxMenu

All Implemented Interfaces:

Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, AjaxableComponent, Badgeable, EventValidator, Hideable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable

@Component
public class TaskBoxMenu
extends TaskBox
implements EventValidator

This class, that extends TaskBox, defines the component to be included inside the TaskBar, which is used to insert the global menu of the application.

See Also:

• Serialized Form

GCApi:

component

Nested Class Summary

Nested classes/interfaces inherited from class overit.geocall.ui.Component

Component.Configurable, Component.ConfigurableAttribute, Component.ConfigurableAttributes, Component.FilterCriteria, Component.Registry

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_linkedro
protected String	_msgPercorsoCorrente
protected String	_msgSessioneInvalidata
protected String	unlicensedModuleMsg

Fields inherited from class overit.geocall.basic.ui.control.TaskBox

_open, _value, _visible, ENABLED_ATTR, FUNCTION_ATTR, ICON_ATTR, LABEL_ATTR, MODULE_ATTR, POS_ATTR, RO_ATTR, safeInlineService, SHOW_ON_MENU_ATTR

Fields inherited from class overit.geocall.ui.Control

_blank, _cleaner, _dblink, _enabled, _ro, _title, altEventIconsList, altIcon, ariaDescription, ariaLabel, badge, badgeformat, FILTER_PREFIXES, LABEL_ATTRIBUTE, LABEL_IN_LINE_ATTRIBUTE, STATE_BLANK, STATE_NORMAL, STATE_RO, STATE_ROBLANK

Fields inherited from class overit.geocall.ui.Component

_basic, _childrenContainers, _currentId, _gridalign, _gridcols, _gridrows, _gridvalign, _iconElement, _id, _keylabel, _label, _layoutName, _name, _parentContainer, _registryName, _shortcut, _tabindex, _transformations, _valuesContainer, aliasField, BR, configHidden, configuredLabel, configuredLabelInLine, defaultHidden, ELEMENT_BR, ELEMENT_NULL, entityContainer, entityName, extendedField, fullHeight, important, labelInLine, layoutLabel, PIXEL_IMG

Fields inherited from interface overit.geocall.ui.AjaxableComponent

FRAME_ID_PREFIX, NOTRANSITION, TRANSITION_BODY_MORPH, TRANSITION_BODY_RESIZE, TRANSITION_BORDER_RESIZE, TRANSITION_DOWN, TRANSITION_UP

Constructor Summary

Constructors

Constructor	Description
TaskBoxMenu(SafeInlineService safeInlineService)

Method Summary

Modifier and Type	Method	Description
void	buildDisplayScript(StringBuilder sb)	Every component can add a script to the StringBuilder, script executed when the component is displayed.
protected void	collectRootAncestor(List<org.apache.ecs.Element> ancestors)
org.apache.ecs.Element	getFrameHtml(overit.geocall.ux.servlet.processor.Change change, EntitySet es)	Defines the html part of the element that changes when an Ajax interaction occurs
protected org.apache.ecs.Element	getMenuSpacer()
boolean	getRO()	Returns the read only state of the Control
org.apache.ecs.Element	getTopBarHtml(EntitySet es)	Deprecated. Returns the html of the menu bar positioned at the top of the page (maintained only for the old versions of the kernel)
protected org.apache.ecs.Element	getTopTabContent(int menu, String label, String icon, boolean off, boolean ro)
protected boolean	isLicenseStrict()
protected boolean	isLicenseStrict(boolean isValidLicense)
protected boolean	licenseHasModule(String module)
protected boolean	licenseHasModule(String module, boolean isValidLicense)
boolean	needValueValidation()
void	setLINKEDRO(String s)	Defines if the menu defined by the TaskBoxMenu must be in read only state when the page in which is contained is not the only one in the WindowManager.
protected void	setup()	Setup the Component
boolean	validateParams(UIMessage uim)	Checks if the parameters are valid or not

Methods inherited from class overit.geocall.basic.ui.control.TaskBox

changed, draw, draw, getDefaultChange, getHtml, getOPEN, isVisible, setOPEN, setVISIBLE

Methods inherited from class overit.geocall.ui.Control

avoidNull, clean, getBadgeFormat, getBadgeValue, getBLANK, getCleaner, getConfigurableProperties, getDAValues, getDBLINK, getKEYLABEL, getLABEL, getState, getTITLE, getValues, getWM, isEnabled, isEnabledBasedOnFunction, isFunctionEnabled, isImportant, isRoBasedOnFunction, nameWithNoFilterPrefix, setALTEVENTICON, setALTICON, setARIADESCRIPTION, setARIALABEL, setBADGEFORMAT, setBADGEVALUE, setBLANK, setCLEANER, setConfiguredProperty, setDBLINK, setENABLED, setFUNCTION, setModelProperties, setRO, setTitle, setTITLE

Methods inherited from class overit.geocall.ui.Component

adapt, ajaxQuery, appendAttribute, buildSetupScript, calcKeyLabel, calcLabel, calcShortcut, canBeConfigured, changed, clearConfiguredProperties, componentIterator, componentSize, connect, containerIterator, createAjaxFrame, deprecate, fillSetupScript, generateFlexableFullHeightContainer, generateId, getBASIC, getBoolean, getBoolean, getChildrenComponents, getChildrenContainers, getDefaultLabel, getDefaultLayoutLabel, getEntityContainer, getEntityName, getFullHeight, getGridAlign, getGridCols, getGridRows, getGridVAlign, getHtmlLabel, getHtmlLabel, getIcon, getId, getIdentity, getint, getLayoutLabel, getLayoutName, getNAME, getParentComponent, getParentContainer, getPublishedChildrenList, getRegistryName, getSHORTCUT, getTabIndex, getTeacher, getValuesContainer, getWindow, initChilds, isActivable, isActive, isAliasField, isConfigHidden, isDefaultHidden, isExtendedField, isLabelInLine, onInit, setActivable, setActive, setAliasField, setBASIC, setConfigHidden, setDEFAULTHIDDEN, setEntityName, setExtendedField, setFULLHEIGHT, setGRIDALIGN, setGRIDCOLS, setGRIDROWS, setGRIDVALIGN, setICON, setIdentity, setIMPORTANT, setLabel, setLABEL, setLABELINLINE, setLAYOUTLABEL, setLAYOUTNAME, setNAME, setREGISTRYNAME, setTooltip, setValuesContainer, stringForJs, tabIndexer

Methods inherited from class overit.geocall.platform.ui.UINode

addChild, addChildText, getChildren, getNodeId, getParent, getRoot, getSchema, setNodeId, setParent, setSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface overit.geocall.ui.Badgeable

badgeFormat, makeBadgedIcon

Methods inherited from interface overit.geocall.ui.Hideable

getVISIBLE

Field Details

_linkedro

protected boolean _linkedro

_msgSessioneInvalidata

protected String _msgSessioneInvalidata

_msgPercorsoCorrente

protected String _msgPercorsoCorrente

unlicensedModuleMsg

protected String unlicensedModuleMsg

Constructor Details

TaskBoxMenu

public TaskBoxMenu(SafeInlineService safeInlineService)

Method Details

setup

protected void setup()

Description copied from class: Component

Setup the Component

Overrides:

setup in class Component

setLINKEDRO

public void setLINKEDRO(String s)

Defines if the menu defined by the TaskBoxMenu must be in read only state when the page in which is contained is not the only one in the WindowManager. You can set this attribute to true to prevent that the user navigate out of the page in a way that is not permitted by the logical flow of interaction

Parameters:

s - A string that represents a boolean value ("true" or "1", "false" or "0").
If the string is not recognized as a boolean value, it will be used the default value, that is false

getRO

public boolean getRO()

Description copied from class: Control

Returns the read only state of the Control

Overrides:

getRO in class Control

Returns:

true if the control is read only, false otherwise

getFrameHtml

public org.apache.ecs.Element getFrameHtml(overit.geocall.ux.servlet.processor.Change change,
 EntitySet es)

Description copied from interface: AjaxableComponent

Defines the html part of the element that changes when an Ajax interaction occurs

Specified by:

getFrameHtml in interface AjaxableComponent

Overrides:

getFrameHtml in class TaskBox

Parameters:

change - The Change object that defines the specific morphing type for the element

es - The EntitySet to which the element belongs

Returns:

The html part of the element that changes when an Ajax interaction occurs

collectRootAncestor

protected void collectRootAncestor(List<org.apache.ecs.Element> ancestors)

getTopBarHtml

@Deprecated(since="")
public org.apache.ecs.Element getTopBarHtml(EntitySet es)

Deprecated.

Returns the html of the menu bar positioned at the top of the page (maintained only for the old versions of the kernel)

Parameters:

es - The EntitySet to which the element belongs

Returns:

The html code of the top bar

getTopTabContent

protected org.apache.ecs.Element getTopTabContent(int menu,
 String label,
 String icon,
 boolean off,
 boolean ro)

validateParams

public boolean validateParams(UIMessage uim)

Description copied from interface: EventValidator

Checks if the parameters are valid or not

Specified by:

validateParams in interface EventValidator

Parameters:

uim - The UIMessage that contains the parameters that must be validated

Returns:

true if the parameters are valid, false otherwise

needValueValidation

public boolean needValueValidation()

Specified by:

needValueValidation in interface EventValidator

licenseHasModule

protected boolean licenseHasModule(String module)

isLicenseStrict

protected boolean isLicenseStrict()

licenseHasModule

protected boolean licenseHasModule(String module,
 boolean isValidLicense)

isLicenseStrict

protected boolean isLicenseStrict(boolean isValidLicense)

getMenuSpacer

protected org.apache.ecs.Element getMenuSpacer()

buildDisplayScript

public void buildDisplayScript(StringBuilder sb)

Description copied from class: Component

Every component can add a script to the StringBuilder, script executed when the component is displayed.

Overrides:

buildDisplayScript in class Component

Parameters:

sb - The StringBuilder on which we want to add the script