Package overit.geocall.basic.ui.control

Class TaskBoxFavoritesMenu

java.lang.Object

overit.geocall.platform.ui.UINode

overit.geocall.ui.Component

overit.geocall.ui.Control

overit.geocall.basic.ui.control.TaskBoxFavoritesMenu

All Implemented Interfaces:

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

public class TaskBoxFavoritesMenu
extends Control
implements EventValidator, AjaxableComponent

This class defines the component inserted inside the TaskBar, which is used to group the menu items (TaskMessage) belonging to the favorites menu.

See Also:

• Serialized Form

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
static final String	ID

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
TaskBoxFavoritesMenu(UINode parent, WindowManager wm, TeacherDuty td, Window w, String destination, int tabIndex)

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.
void	changed(overit.geocall.ux.servlet.processor.Change change)	Defines the morphing of the element that occurs when there is an Ajax interaction
protected org.apache.ecs.Element	drawfavoritesBox(boolean open, String name, String id, String keylabel, ArrayList<org.apache.ecs.Element> elements)
overit.geocall.ux.servlet.processor.Change	getDefaultChange()	Defines the default Change object for the element
protected List<org.apache.ecs.Element>	getFavorites(List<XMLTree> favoritesNodes, EntitySet es, String selected, boolean readOnly)
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
org.apache.ecs.Element	getHtml(EntitySet es)	Abstract method that must be extended and returns the html code of the Component
protected String	getOriginalPathTooltip(XMLTree node)
boolean	needValueValidation()
boolean	validateParams(UIMessage uim)	Checks if the parameters are valid or not

Methods inherited from class overit.geocall.ui.Control

avoidNull, clean, getBadgeFormat, getBadgeValue, getBLANK, getCleaner, getConfigurableProperties, getDAValues, getDBLINK, getKEYLABEL, getLABEL, getRO, 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, setup, 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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

TaskBoxFavoritesMenu

public TaskBoxFavoritesMenu(UINode parent,
 WindowManager wm,
 TeacherDuty td,
 Window w,
 String destination,
 int tabIndex)

Method Details

changed

public void changed(overit.geocall.ux.servlet.processor.Change change)

Description copied from interface: AjaxableComponent

Defines the morphing of the element that occurs when there is an Ajax interaction

Specified by:

changed in interface AjaxableComponent

Parameters:

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

getDefaultChange

public overit.geocall.ux.servlet.processor.Change getDefaultChange()

Description copied from interface: AjaxableComponent

Defines the default Change object for the element

Specified by:

getDefaultChange in interface AjaxableComponent

Returns:

The default Change object that defines the default morphing type of the element

getHtml

public org.apache.ecs.Element getHtml(EntitySet es)

Description copied from class: Component

Abstract method that must be extended and returns the html code of the Component

Specified by:

getHtml in class Component

Parameters:

es - The EntitySet to which the element belongs

Returns:

The html of the Component

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

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

getFavorites

protected List<org.apache.ecs.Element> getFavorites(List<XMLTree> favoritesNodes,
 EntitySet es,
 String selected,
 boolean readOnly)

drawfavoritesBox

protected org.apache.ecs.Element drawfavoritesBox(boolean open,
 String name,
 String id,
 String keylabel,
 ArrayList<org.apache.ecs.Element> elements)

getOriginalPathTooltip

protected String getOriginalPathTooltip(XMLTree node)

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

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