Package com.github.tadukoo.view.form.main

Interface MainForm

All Superinterfaces:
Form, com.github.tadukoo.util.pojo.MappedPojo
All Known Subinterfaces:
SimpleMainForm, TabbedMainForm
All Known Implementing Classes:
AbstractSimpleMainForm, AbstractTabbedMainForm
public interface MainForm extends Form
Main Form represents the main Form in a program for a user to interact with. As such, it's expected that the Main Form will inherit from JFrame to provide everything needed.
Version:
Alpha v.0.3.3
Author:
Logan Ferree (Tadukoo)

  • Method Summary

    Modifier and Type
    Method
    Description
    JFrame
    asFrame()
     
    default void
    configureFrameSettings()
    Configures frame settings for this Main Form.
    default CloseOperation
    defaultCloseOperation()
     
    default Dimension
    framePreferredSize()
     
    default String
    iconPath()
     
    default void
    launch()
    Launches this Main Form (default is setting visible to true)

    Methods inherited from interface com.github.tadukoo.view.form.Form

    asComponent, saveValues

    Methods inherited from interface com.github.tadukoo.util.pojo.MappedPojo

    clear, getItem, getKeys, getListItem, getListItemNoThrow, getListItemNoThrow, getMap, getPojoItem, getPojoItemNoThrow, getPojoItemNoThrow, hasItem, hasKey, isEmpty, removeItem, setItem

  • Method Details

    • asFrame

      JFrame asFrame()
      Returns:
      This form as a JFrame

    • defaultCloseOperation

      default CloseOperation defaultCloseOperation()
      Returns:
      The default CloseOperation to use for this Main Form

    • iconPath

      default String iconPath()
      Returns:
      The filepath to the icon to use for this Main Form (can be null to not set an icon)

    • framePreferredSize

      default Dimension framePreferredSize()
      Returns:
      The Dimension for the preferred size of this Main Form (can be null to not set a preferred size)

    • configureFrameSettings

      default void configureFrameSettings()
      Configures frame settings for this Main Form. This method should be called by the constructor to at least set the defaultCloseOperation(), use the iconPath() and framePreferredSize() if they're not null, and add the inner component to the frame

    • launch

      default void launch()
      Launches this Main Form (default is setting visible to true)