com.jwebmp.plugins.bootstrap.media.BSMedia Maven / Gradle / Ivy
Show all versions of jwebmp-bootstrap Show documentation
/*
* Copyright (C) 2017 Marc Magon
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see
* The media object is an abstract element used as the basis for building more complex and repetitive components (like blog comments, Tweets, etc).
*
* Included is support for left and right aligned content, content alignment options, nesting, and more.
*
* @param
*
* @author Marc Magon
* @version 1.0
* @since 29 Aug 2015
*/
@ComponentInformation(name = "Bootstrap Media",
description = "The media object helps build complex and repetitive components where some media is positioned alongside content that doesn’t wrap around said media. Plus, it does this with only two required classes thanks to flexbox.",
url = "https://v4-alpha.getbootstrap.com/layout/media-object/",
wikiUrl = "https://github.com/GedMarc/JWebSwing-BootstrapPlugin/wiki")
public class BSMedia>
extends Div
implements IBSMedia
{
private static final long serialVersionUID = 1L;
/**
* The link for the media object
*/
private Link mediaLink;
/**
* The body for the media object
*/
private Div mediaBody;
/**
* The header for the media object
*/
private HeaderText mediaHeader;
/**
* The media object being displayed (usually image or something)
*/
private Component mediaComponent;
/**
* The media object is an abstract element used as the basis for building more complex and repetitive components (like blog comments, Tweets, etc).
*
* Included is support for left and right aligned content, content alignment options, nesting, and more.
*/
public BSMedia()
{
addClass(BSComponentMediaOptions.Media);
}
/**
* Returns the body portion of this media object
*
* @return
*/
@Override
public Div getMediaBody()
{
if (mediaBody == null)
{
setMediaBody(new Div());
}
return mediaBody;
}
/**
* Sets the media body and adds it to this object
*
* @param mediaBody
*
* @return
*/
@Override
public BSMedia setMediaBody(Div mediaBody)
{
if (this.mediaBody != null)
{
getChildren().remove(this.mediaBody);
this.mediaBody = null;
}
this.mediaBody = mediaBody;
if (this.mediaBody != null)
{
this.mediaBody.addClass(BSComponentMediaOptions.Media_Body);
}
getChildren().add(mediaBody);
return this;
}
/**
* Returns the component displayed inside the link that is used for display
*
* @return
*/
@Override
public Component getMediaComponent()
{
if (mediaComponent == null)
{
setMediaComponent(new Div());
}
return mediaComponent;
}
/**
* Returns a new H4 header
*
* @return
*/
@Override
public HeaderText getMediaHeader()
{
if (mediaHeader == null)
{
setMediaHeader(new H4(""));
}
return mediaHeader;
}
/**
* Returns the associated media link, never null
*
* @return
*/
@Override
public Link getMediaLink()
{
if (mediaLink == null)
{
setMediaLink(new Link(STRING_HASH), true);
}
return mediaLink;
}
/**
* Sets the header to the required object
*
* @param mediaHeader
*
* @return
*/
@Override
public BSMedia setMediaHeader(HeaderText mediaHeader)
{
if (this.mediaHeader != null)
{
getMediaBody().remove(this.mediaHeader);
this.mediaHeader = null;
}
this.mediaHeader = mediaHeader;
if (this.mediaHeader != null)
{
this.mediaHeader.addClass(BSComponentMediaOptions.Media_Heading);
getMediaBody().add(this.mediaHeader);
}
return this;
}
/**
* Sets the media link, and moves the media object into the new link if necessary
*
* @param mediaLink
* @param left
*
* @return
*/
@Override
public BSMedia setMediaLink(Link mediaLink, boolean left)
{
if (this.mediaLink != null)
{
mediaLink.add(getMediaComponent());
getChildren().remove(this.mediaLink);
this.mediaLink = null;
}
this.mediaLink = mediaLink;
if (this.mediaLink != null)
{
if (left)
{
this.mediaLink.addClass(BSComponentMediaOptions.Media_Left);
}
else
{
this.mediaLink.addClass(BSComponentMediaOptions.Media_Right);
}
getChildren().add(this.mediaLink);
}
return this;
}
/**
* Sets the component displayed to the left or right (set that in the link)
*
* @param mediaComponent
*
* @return
*/
@Override
public BSMedia setMediaComponent(Component mediaComponent)
{
if (this.mediaComponent != null)
{
getMediaLink().remove(this.mediaComponent);
this.mediaComponent = null;
}
this.mediaComponent = mediaComponent;
if (this.mediaComponent != null)
{
this.mediaComponent.addClass(BSComponentMediaOptions.Media_Object);
getMediaLink().add(this.mediaComponent);
}
return this;
}
@Override
public int hashCode()
{
return Objects.hash(super.hashCode(), getMediaLink(), getMediaBody(), getMediaHeader(), getMediaComponent());
}
@Override
public boolean equals(Object o)
{
if (this == o)
{
return true;
}
if (!(o instanceof BSMedia))
{
return false;
}
if (!super.equals(o))
{
return false;
}
BSMedia bsMedia = (BSMedia) o;
return Objects.equals(getMediaLink(), bsMedia.getMediaLink()) &&
Objects.equals(getMediaBody(), bsMedia.getMediaBody()) &&
Objects.equals(getMediaHeader(),
bsMedia.getMediaHeader()) &&
Objects.equals(
getMediaComponent(), bsMedia.getMediaComponent());
}
}