Package com.axemble.vdoc.sdk.interfaces.ui

Interface IWidget

All Superinterfaces:
IWritable, Serializable
All Known Subinterfaces:
IBaseDesignManualTask, IBlock, IButton, IContainer, IDesignAbortTask, IDesignAction, IDesignAndJoin, IDesignAnnotation, IDesignApplicationManualTask, IDesignBlock, IDesignCellBlock, IDesignComponent, IDesignConnectorTreatmentTask, IDesignContentComponent, IDesignElement, IDesignEmbeddedWorkflowTask, IDesignEndTask, IDesignField, IDesignFieldLabel, IDesignFieldTreatmentTask, IDesignForm, IDesignFormBlock, IDesignLineBlock, IDesignLink, IDesignManualTask, IDesignParallel, IDesignProperty, IDesignRoleTreatmentTask, IDesignScriptTreatmentTask, IDesignSectionBlock, IDesignStartTask, IDesignStateTreatmentTask, IDesignTableBlock, IDesignTask, IDesignTest, IDesignTreatmentGroupTask, IDesignTreatmentTask, IDesignWorkflow, IFieldComponent, INamedContainer, INamedWidget, InputConnectionPoint, ISelectionSupport, IText, OutputConnectionPoint
All Known Implementing Classes:
com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseComponent, BaseField, com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseFieldComponent, com.axemble.vdp.ui.framework.widgets.components.sys.base.BaseInputComponent, BaseNavigation, BaseToolProvider.NamedWidget, BaseWorkflowField, com.axemble.vdp.ui.framework.composites.base.CtlAbstractNavigation, com.axemble.vdp.ui.framework.widgets.CtlInputWidget, CustomSelectionComponent, FileSizeInputComponent, LightBoxField, LocalizedTextField, PeriodSelectionRangeDatePickerField, SelectionRangeDatePickerField, SelectionRangeTimePickerField, SelectListCustomInputComponent, UrlSelectorField, com.axemble.vdp.ui.framework.foundation.Widget
public interface IWidget extends IWritable, Serializable
Widget interface
Author:
bchapoton

  • Method Details

    • render

      IWritable render() throws RenderException
      Render the widget
      Returns:
      writableWidget
      Throws:
      RenderException

    • getParentBlock

      IBlock getParentBlock()
      Get the widget parent block
      Returns:
      parentBlock

    • setParentBlock

      void setParentBlock(IBlock parentBlock)
      Set the widget parent block
      Parameters:
      parentBlock -

    • getSysname

      String getSysname()
      Get widget sysname
      Returns:
      sysName

    • setSysname

      void setSysname(String sysname)
      Set the widget sysName
      Parameters:
      sysname -

    • isHidden

      boolean isHidden()
      Get if widget is hidden
      Returns:
      isHidden

    • setHidden

      void setHidden(boolean isHidden)
      Set if widget is hidden
      Parameters:
      isHidden -

    • afterInit

      void afterInit()
      Called after easysite initialization

    • refresh

      void refresh()
      Refresh the Widget

    • addChangeListener

      void addChangeListener(IChangeListener listener)
      Add a new listener
      Parameters:
      listener -

    • removeChangeListener

      IChangeListener removeChangeListener(IChangeListener listener)
      Removes an IChangeListenerfrom the Widget.
      Parameters:
      listener - the IChangeListenerto remove.

    • removeChangeListeners

      void removeChangeListeners()
      Removes all changeListeners from the Widget.

    • hasChangeListeners

      boolean hasChangeListeners()
      Returns true if the list has a change listener, false otherwise.
      Returns:
      true if the list has a change listener, false otherwise.

    • getStaticString

      String getStaticString(String entryID, String arg1)

    • getStaticString

      String getStaticString(String entryID, String arg1, String arg2)

    • getStaticString

      String getStaticString(String entryID, String arg1, String arg2, String arg3)

    • getStaticString

      String getStaticString(String entryID, String arg1, String arg2, String arg3, String arg4)

    • getStaticString

      String getStaticString(String entryID)
      Retrieve the string to display via its key
      Parameters:
      entryID -
      Returns:

    • addActionListener

      void addActionListener(IAnyActionListener listener)
      Add a new listener
      Parameters:
      listener -

    • removeActionListener

      IAnyActionListener removeActionListener(IAnyActionListener listener)
      Removes an IAnyActionListenerfrom the Widget.
      Parameters:
      listener - the IAnyActionListenerto remove.

    • removeActionListeners

      void removeActionListeners()
      Removes all actionListeners from the Widget.

    • hasActionListeners

      boolean hasActionListeners()
      Returns true if the list has a action listener, false otherwise.
      Returns:
      true if the list has a action listener, false otherwise.

    • renderMobile

      IWritable renderMobile() throws RenderException
      Render the widget in mobile context
      Returns:
      Throws:
      RenderException

    • refreshWidgets

      void refreshWidgets()
      Refresh the Widget

    • getParam

      Object getParam()

    • getCtrlTemplate

      ITemplate getCtrlTemplate(String templateFileName) throws RenderException
      Throws:
      RenderException

    • getCtrlTemplateWriter

      ITemplateWriter getCtrlTemplateWriter(String templateFileName) throws RenderException
      Throws:
      RenderException