Package overit.geocall.basic.ui.control

Class SearchBoxMenu

java.lang.Object

overit.geocall.platform.ui.UINode

overit.geocall.ui.Component

overit.geocall.ui.Control

overit.geocall.basic.ui.control.SearchBoxMenu

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 SearchBoxMenu
extends Control
implements EventValidator, AjaxableComponent

This component is use to display the new search box when the hideable favorites mode is active
When it's active this new mode the search bar, into the identity box, will be placed above the favorites box and will be displayed an icon on its left side that allows the user to hide/show the entire favorites box

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

Method Summary

Modifier and Type	Method	Description
void	changed(overit.geocall.ux.servlet.processor.Change change)	Defines the morphing of the element that occurs when there is an Ajax interaction
overit.geocall.ux.servlet.processor.Change	getDefaultChange()	Defines the default Change object for the element
org.apache.ecs.Element	getFrameHtml(overit.geocall.ux.servlet.processor.Change c, 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 org.apache.ecs.Element	getSearchBox()
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, buildDisplayScript, 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

SearchBoxMenu

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

Method Details

getFrameHtml

public org.apache.ecs.Element getFrameHtml(overit.geocall.ux.servlet.processor.Change c,
 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:

c - 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

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

getSearchBox

protected org.apache.ecs.Element getSearchBox()

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