Package overit.geocall.basic.ui.container

Class Panel

java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.Container
overit.geocall.basic.ui.container.Panel
All Implemented Interfaces:
Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, AjaxableComponent, Badgeable, Hideable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable
Direct Known Subclasses:
ActivityTimeframeManagement, AddForecastActivity, AddGroupingConstraintPanel, AllocateTechnicians, CentralMobileWarehouseAssociation, CentralWarehouseAddresses, CopyActivityForecast, CopyForecastResourceDetail, CopyForecastShiftModel, CopyResourceForecast, CopyWorkloadAnalysis, CPanelNewOdlFromNotification, CrewShellsSelectionPanel, CrewShellsTypeSelectionPanel, DataCollectionNodeInfoPanel, DataCollectionOptionGroupOptions, EditActivityForecastHeader, EditCapacityPlanningScenario, EditForecastActivityPriorityPanel, EditForecastGroupingConstraintPanel, EditForecastResource, EditForecastShiftModel, EditForecastShiftModelDetail, EditMaterialAccountingPanel, EditResourceForecastHeader, EditResourceGroupingConstraint, EditRoughPlanning, EditSkillPanel, ForecastResourceDetailManagement, GenerateTransaction, ImportForecastResources, ImportOperationActivityPanel, InventoryPositionCoordMap, ManageCrewShellSkill, ManageForemanPanel, ManualCoordinates, MeterReadings, OperationCenterWorkCenters, PAgendaAffinityPreview, PanelBlockingWarnings, PanelCancelActivities, PanelCheckResult, PanelCreateBundle, PanelDataCollectionConverterSheetSubset, PanelDataCollectionConverterTemplateSubset, PanelDataCollectionGlobalExpression, PanelDataCollectionNodeAttachmentUploadFile, PanelDataCollectionNodeDownloadAttachmentUploadFile, PanelDataCollectionNodeMatrixBase, PanelDataCollectionNodeSelectionOption, PanelDataCollectionOptionsGroup, PanelDataCollectionOptionsGroupUploadModel, PanelDataCollectionRawModel, PanelDataCollectionSheetCoordMap, PanelDataCollectionSheetDetailCalculatedNodes, PanelDataCollectionTemplateGanttLegend, PanelDataCollectionTemplateReleaseSelection, PanelDataCollectionTemplateUpload, PanelDataCollectionTemplateUploadModel, PanelDataCollectionTemplateUploadPdfForm, PanelDataCollectionTemplateVisibilityRules, PanelDataCollectionTreeViewModel, PanelDataCollectionType, PanelEditDataCollectionTemplate, PanelEditDataCollectionTemplateStructureBase, PanelEditDataCollectionTemplateWOCreationRule, PanelEditMobileCardsRule, PanelEditMultistageGroup, PanelGapFillerResults, PanelManageTask, PanelMeterTemplate, PanelMultiSelectDataCollectionTemplate, PanelMultistageConfiguration, PanelMultistageDependencies, PanelMultistageGroupGanttLegend, PanelMultistageViolations, PanelNewDataCollectionSheet, PanelNewDataCollectionTemplate, PanelNewDataCollectionTemplateStructureRelease, PanelNewDataCollectionTemplateWOCreationRule, PanelNewMobileCardsRule, PanelNewMultistageGroup, PanelNewNotificationLight, PanelOutcomeReasonsDataCollectionTemplate, PanelReleaseProject, PanelRenameExport, PanelReopenTimesheets, PanelResourcesScheduling, PanelSelectBundle, PanelSelectBundleOperationOrdering, PanelSelectBundlingRule, PanelSelectCriticalActivityRule, PanelSelectDataCollectionOptionsGroup, PanelSelectDataCollectionOptionsTable, PanelSelectDataCollectionSheet, PanelSelectDataCollectionTemplate, PanelSelectForecastActivity, PanelSelectionActivityForecastHeader, PanelSelectionResourceForecastHeader, PanelSelectMultistageGroup, PanelSelectOutcomeReason, PanelSelectPermitType, PanelSelectResources, PanelSelectSerializedMaterial, PanelSelectUsersByKind, PanelTaskCategoryEventType, PanelTimesheetProfile, PanelTimesheetTaskCategory, PanelUpdateBundle, PanelViewCriticalActivityRules, PanelViewDataCollectionTemplateWOCreationRule, PAssociateStructure, PBulkOutcomeUpdate, PDataCollectionTemplateGanttUIConfiguration, overit.geocallapp.wfm.ui.container.PDecoderSelection, PDurationPreview, PEditActivityRelation, PEditMeter, PEditProjectDiary, PEditRange, PForecastActivityDetailGanttUIConfiguration, PGanttLegend, PGanttLegend, PGanttUIStateConfiguration, PInsertActivityRelation, PLegend, PMultiSelectCardTypes, PNewNotification, PNewWorkOrderNote, PProjectProfile, PProjectSelection, PSearchSchedulableBundles, PSearchUrgentActivities, PSelectCardIcon, PSelectProjectWOType, PSingleProjectDiaryHistory, PWorkOrderNote, RoughPlanningConfiguration, SearchFeatureRules, SearchSchedulingUsers, SelectionPanel, SelectionPanelForecastResource, SelectItemFilters, SelectWorkOrderFilters, overit.geocallapp.wfm.users.workshifts.common.ShiftsPanel, StockChange, WarehouseOperationCenterAssociation, WOOperationPredictionMaterials, WorkOrderOperationAffinity
@Component public class Panel extends Container implements Hideable, AjaxableComponent
The class that extends Container implements the user interface element that represents a portion of the page that can be showed or hidden and pops-up, on demand, overlapping the user window.
It can be a panel that blocks the user interaction with the mask below (like for example an editing panel used to change some values) as well as a panel that allows the interaction (like for example a panel that contains a legend that explain something).
See Also:
GCApi:
component

  • Field Details

    • _visible

      protected SetPredicate _visible

    • _appear

      protected char _appear

    • _type

      protected String _type

    • _valign

      protected char _valign

    • _align

      protected char _align

    • _modal

      protected boolean _modal

    • _obj

      protected Object _obj

    • _minWidth

      protected String _minWidth

    • _minHeight

      protected String _minHeight

    • _width

      protected String _width

    • _height

      protected String _height

    • _maxWidth

      protected String _maxWidth

    • _maxHeight

      protected String _maxHeight

    • _moveable

      protected Boolean _moveable

    • _titleClosable

      protected String _titleClosable

  • Constructor Details

    • Panel

      public Panel()

  • Method Details

    • perfectsDim

      protected static String perfectsDim(String s)

    • setMINWIDTH

      public void setMINWIDTH(String s)
      Sets the minimum width of the panel
      Parameters:
      s - The minimum width, expressed in pixels or as a percentage of the browser window (introducing explicitly the % character)

    • setMINHEIGHT

      public void setMINHEIGHT(String s)
      Sets the minimum height of the panel
      Parameters:
      s - The minimum height, expressed in pixel or as a percentage of the browser window (introducing explicitly the % character)

    • setWIDTH

      public void setWIDTH(String s)
      Sets the width of the panel. If the content of the panel occupies more space than the width defined, then the horizontal scrollbar will appear
      Parameters:
      s - The width, expressed in pixel or as a percentage of the browser window (introducing explicitly the % character)

    • setHEIGHT

      public void setHEIGHT(String s)
      Sets the height of the panel. If the content of the panel occupies more space than the height defined, then the vertical scrollbar will appear
      Parameters:
      s - The height, expressed in pixel or as a percentage of the browser window (introducing explicitly the % character)

    • setMAXWIDTH

      public void setMAXWIDTH(String s)
      Sets the maximum width of the panel. If the content of the panel occupies more space than the maximum width defined, then the horizontal scrollbar will appear
      Parameters:
      s - The maximum width, expressed in pixel or as a percentage of the browser window (introducing explicitly the % character)

    • setMAXHEIGHT

      public void setMAXHEIGHT(String s)
      Sets the maximum height of the panel. If the content of the panel occupies more space than the maximum height defined, then the vertical scrollbar will appear
      Parameters:
      s - The maximum height, expressed in pixel or as a percentage of the browser window (introducing explicitly the % character)

    • setMOVEABLE

      public void setMOVEABLE(String s)
      Defines whether the user can move the panel (by dragging it from the edges), or not
      Parameters:
      s - A string that represent a boolean value ("true" or "1" to obtain moveable panels, "false" or "0" otherwise).
      If the string is not recognized as a boolean value, it will be used the default value, that is false

    • setTITLECLOSABLE

      public void setTITLECLOSABLE(String s)
      Defines the possibility of closing the panel through a button that will appear, setting this attribute and only in the case where the panel has a title (setTitle()), in the upper right corner of the header of the panel. The attribute it can be a string that represents a boolean (true to execute the standard onClose() method, false to not show the button), or the name of the desired event to trigger when the button is pressed
      Parameters:
      s - A string that represent a boolean value ("true" or "1", "false" or "0" otherwise).
      If the string is not recognized as a boolean value, it will be used as the name of the event to trigger when the button is pressed

    • setMODAL

      public void setMODAL(String s)
      Defines whether the panel blocks the user interaction with the page below, or not
      Parameters:
      s - A string that represent a boolean value ("true" or "1" to blocks the interaction, "false" or "0" otherwise).
      If the string is not recognized as a boolean value, it will be used the default value, that is true

    • setVISIBLE

      public void setVISIBLE(String s)
      Used to define if the panel is visible and must appear, or not
      Specified by:
      setVISIBLE in interface Hideable
      Parameters:
      s - A string that represent a boolean value ("true" or "1", "false" or "0") or a function.
      If the string is not recognized as a boolean value, it is considered as a user function with this meaning: if the user currently logged in the application has the function, the panel will be showed, otherwise it will not

    • setTYPE

      public void setTYPE(String type)
      Defines the type of the panel. A panel can be a "central panel" that appears and floats in the center of the page, or a "edge panel" that appears from one edge of the window and remain hooked to it.
      Parameters:
      type - A character that represents the type of the panel. The possible values are:
      "c": central panel
      "r": panel hooked to the right edge of the window
      "l": panel hooked to the left edge of the window
      "t": panel hooked on the top edge of the window
      "b": panel hooked on the bottom edge of the window

    • setALIGN

      public void setALIGN(String s)
      Defines the horizontal alignment of the content of the panel
      Parameters:
      s - Possible values are "left" or "right"

    • setVALIGN

      public void setVALIGN(String s)
      Defines the vertical alignment of the content of the panel
      Parameters:
      s - Possible values are "top" or "bottom"

    • show

      @Deprecated public void show(Object obj)
      Deprecated.
      use the more specific overload instead It shows (make visible with the pop-up effect) the panel
      Parameters:
      obj - Object saved as a global variable of the panel

    • show

      public void show()
      It shows (make visible with the pop-up effect) the panel

    • show

      public void show(Serializable obj)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      obj - serializable object saved as a global variable of the panel

    • show

      public void show(Integer i)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      i - integer value saved as a global variable of the panel

    • show

      public void show(Short s)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      s - short value saved as a global variable of the panel

    • show

      public void show(Long l)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      l - long value saved as a global variable of the panel

    • show

      public void show(Float f)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      f - float value saved as a global variable of the panel

    • show

      public void show(Double d)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      d - double value saved as a global variable of the panel

    • show

      public void show(Character c)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      c - char value saved as a global variable of the panel

    • show

      public void show(Byte b)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      b - byte value saved as a global variable of the panel

    • show

      public void show(Boolean b)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      b - boolean value saved as a global variable of the panel

    • show

      public void show(String s)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      s - string value saved as a global variable of the panel

    • show

      public void show(Component component)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      component - Component instance saved as a global variable of the panel

    • show

      public void show(DynO dynO)
      It shows (make visible with the pop-up effect) the panel
      Parameters:
      dynO - DynO instance saved as a global variable of the panel

    • hide

      public void hide()
      It hides (make not visible, with the pop-up effect) the panel

    • isVisible

      public boolean isVisible()
      Checks if the panel is rendered for the user currently logged in the application, or not (see getBoolean(visible,id,true))
      Specified by:
      isVisible in interface Hideable
      Returns:
      true if the panel is visible, false otherwise

    • setup

      public void setup()
      Description copied from class: Component
      Setup the Component
      Overrides:
      setup in class Component

    • onClose

      public boolean onClose(HashGetter hg)
      It hides (make not visible, with the pop-up effect) the panel
      Parameters:
      hg - Not used
      Returns:
      true

    • getHtml

      public org.apache.ecs.Element getHtml(EntitySet es)
      Description copied from class: Container
      Returns the html code of the Container
      Overrides:
      getHtml in class Container
      Parameters:
      es - The EntitySet to which the element belong
      Returns:
      The html code of the Container

    • getFrameHtml

      public org.apache.ecs.Element getFrameHtml(overit.geocall.ux.servlet.processor.Change change, EntitySet es)
      Method that implements the AjaxableComponent interface. It defines the html part of the panel 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 panel
      es - The EntitySet to which the element belongs
      Returns:
      The html part of the panel that changes when an Ajax interaction occurs

    • titlePanel

      protected org.apache.ecs.Element titlePanel(EntitySet es)

    • getTitleDiv

      protected org.apache.ecs.Element getTitleDiv()

    • changed

      public void changed(overit.geocall.ux.servlet.processor.Change change)
      Method that implements the AjaxableComponent interface. It defines the morphing of the panel 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 panel

    • getDefaultChange

      public overit.geocall.ux.servlet.processor.Change getDefaultChange()
      Method that implements the AjaxableComponent interface. It defines the default Change object for the panel
      Specified by:
      getDefaultChange in interface AjaxableComponent
      Returns:
      The default Change object that defines the default morphing type of the panel

    • buildSetupScript

      public void buildSetupScript(StringBuilder sb)
      Every component can add a script to the StringBuilder, script executed when the component is created The method add the script that manages the visibility of the panel
      Overrides:
      buildSetupScript in class Component
      Parameters:
      sb - The StringBuilder on which we want to add the script

    • onHide

      public boolean onHide(Object o)
      See onClose(overit.geocall.util.HashGetter)
      Parameters:
      o - Not used
      Returns:
      false