org.nasdanika.html.bootstrap.BootstrapFactory Maven / Gradle / Ivy

Go to download
package org.nasdanika.html.bootstrap;

import java.util.Map;

import org.nasdanika.html.HTMLElement;
import org.nasdanika.html.HTMLFactory;
import org.nasdanika.html.HTMLPage;
import org.nasdanika.html.Select;
import org.nasdanika.html.Tag;
import org.nasdanika.html.bootstrap.impl.DefaultBootstrapFactory;


/**
 * Factory for creating bootstrap UI elements. 
 * @author Pavel
 *
 */
public interface BootstrapFactory {
	
	BootstrapFactory INSTANCE = new DefaultBootstrapFactory(HTMLFactory.INSTANCE);
	
	/**
	 * @return Underlying HTML factory.
	 */
	HTMLFactory getHTMLFactory();
	
	Tag alert(Color color, Object... content);
	
	Tag badge(boolean pill, Color color, Object... content);
	Tag badge(boolean pill, Object... content);
	Tag badgeLink(Object href, boolean pill, Color color, Object... content);
	
	/**
	 * Wraps HTML element for applying Bootstrap styling.
	 * @param htmlElement
	 * @return
	 */
	> BootstrapElement> wrap(H htmlElement);
	
	/**
	 * Wraps tag.
	 * @param tag
	 * @return
	 */
	TagBootstrapElement wrap(Tag tag);
			
	Breadcrumb breadcrumb();
	
	/**
	 * Wraps HTML element into a Bootstrap button.
	 * @param htmlElement
	 * @return
	 */
	> Button button(H htmlElement, Color color, boolean outline);
	
	ButtonGroup buttonGroup(boolean vertical);
	
	ButtonToolbar buttonToolbar();
	
	Dropdown dropdown(Button button, boolean split, Direction direction);

	InputGroup inputGroup();
	
	Table table(org.nasdanika.html.Table htmlTable);
	
	/**
	 * Wraps HTML row.
	 * @param row
	 * @return
	 */
	RowContainer.Row row(org.nasdanika.html.RowContainer.Row htmlRow);

	/**
	 * Wraps HTML cell.
	 * @param htmlCell
	 * @return
	 */
	RowContainer.Row.Cell cell(org.nasdanika.html.RowContainer.Row.Cell htmlCell);
	
	
	/**
	 * Creates a new HTML Table, wraps it into Bootstrap table and returns.
	 * @return
	 */
	Table table();
	
	TagBootstrapElement progressBar(int percentage);
	
	/**
	 * 
	 * @param label
	 * @param input
	 * @param hint
	 * @param horizontalLabelWidths If not null and not empty, a horizontal form group is created as explained here - https://getbootstrap.com/docs/4.5/components/forms/#horizontal-form with
	 * label widths taken from the map and control widths computed as 12 - label width.  
	 * @return
	 */
	FormGroup formGroup(Object label, Object input, Object hint, Map horizontalLabelWidths);
	
	> H tooltip(H htmlElement, Object tooltip, boolean html, Placement placement);
	
	> B tooltip(B bootstrapElement, Object tooltip, boolean html, Placement placement);
	
	/**
	 * @return Script to initialize tooltips.
	 */
	Tag initTooltipScript();
	
	Navs navs();
	
	/**
	 * @deprecated Use navs().tabs()
	 * @return
	 */
	@Deprecated
	Navs tabs();

	/**
	 * @deprecated Use navs().pills() 
	 * @return
	 */
	@Deprecated
	Navs pills();
	
	Container container();
	
	Container container(Tag div);
	
	Container fluidContainer();
	
	Container fluidContainer(Tag div);
	
	/**
	 * Adds bootstrap required meta tags to the page.
	 * @param htmlPage
	 * @return
	 */
	 P bootstrapHTMLPage(P htmlPage);

	/**
	 * Adds bootstrap required meta tags and stylesheet and script tags to load
	 * resources from CDN.
	 * @param htmlPage
	 * @return
	 */
	
 P bootstrapCdnHTMLPage(P htmlPage);
	
	/**
	 * Adds bootstrap required meta tags, default or Bootswatch stylesheet and script tags to load
	 * resources from CDN.
	 * @param htmlPage
	 * @param theme Bootswatch theme, uses default theme is null or Default.
	 * @return
	 */
	 P bootstrapCdnHTMLPage(P htmlPage, Theme theme);		
	
	/**
	 * Creates an HTML page with meta tags required by Bootstrap.
	 * @return
	 */
	HTMLPage bootstrapHTMLPage();
	
	/**
	 * Creates an HTML page with Bootstrap stylesheet and scripts served from CDN.
	 * @return
	 */
	HTMLPage bootstrapCdnHTMLPage();
	
	/**
	 * Creates an HTML page with Bootstrap stylesheet and scripts served from CDN.
	 * @param theme Bootswatch theme. Uses the default Bootstrap theme if null or Default.
	 * @return
	 */
	HTMLPage bootstrapCdnHTMLPage(Theme theme);		
	
	/**
	 * Creates a select with themes as options and an event handler to update the application theme on change.  
	 * @return
	 */
	Select themeSelect(Theme selected);
	
	/**
	 * Adds "display-<level>" class.
	 * @param element
	 * @param level Display level from 1 (largest) to 4 (smallest).
	 * @return
	 */
	> H display(H element, int level);
	
	/**
	 * Creates a navbar
	 * @param expandSize
	 * @param dark
	 * @param background
	 * @param brand
	 * @return
	 */
	Navbar navbar(Breakpoint expandSize, boolean dark, Color background, HTMLElement brand);
	
	ListGroup listGroup(boolean flush);
	
	ActionGroup actionGroup(boolean flush);
	
	Card card();
	
	Modal modal();
		
	/* TODO - Implement, add factory method and remove
	 * Modal, 
	 * Ajax modal - JSON response - header, footer, body, size. Clear content, overlay with a spinner, hide footer if no footer content, call update content to resize, show error message on error.

	 * TODO - create issues to implement in later versions (Bootstrap category).
	 * Pagination
	 * Jumbotron
	 * Popover
	 * Progress
	 * Scrollspy
	 * Carousel
	 * Collapse
	 *  
	 *  Other TODO's - load(Map) - to load configuration from, say, YAML files. For both HTML and Bootstrap elements.
	 */
	
}