org.vishia.gral.widget

Class GralViewFileContent

java.lang.Object

org.vishia.gral.base.GralWidgetBase

org.vishia.gral.widget.GralViewFileContent

All Implemented Interfaces:

GralWidgetBase_ifc

public class GralViewFileContent
extends GralWidgetBase

This is a comprehensive widget to show the content of files in some different text coding and also in hexa. Also support search, also support a simple edit. This widget can be used for all situations where file contents should be shown and edit.

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.gral.base.GralWidgetBase

GralWidgetBase.GralWidgComposite, GralWidgetBase.TimeOrderCreateImplWidget

Field Summary

Fields

Modifier and Type	Field and Description
(package private) GralUserAction	actionFind Action for Key F3 for view command.
(package private) GralUserAction	actionOnSetInvisible
GralUserAction	actionOpenView Action for Key F3 for view command.
GralUserAction	actionQuickView Action for Key crl-Q for quick view command.
(package private) GralUserAction	actionSave
(package private) GralUserAction	actionSaveTextAsISO8859_1_unix
(package private) GralUserAction	actionSaveTextAsUTF8unix
(package private) GralUserAction	actionSaveTextAsWindows
(package private) GralUserAction	actionSetEditable Action for Key F3 for view command.
(package private) GralUserAction	actionSetHexView Action for Key F3 for view command.
(package private) GralUserAction	actionSetTextViewISO8859_1 Action for Key F3 for view command.
(package private) GralUserAction	actionSetTextViewUTF8 Action for Key F3 for view command.
private static java.nio.charset.Charset	ascii7
(package private) boolean	bEditable
private GralButton	btnCase
private GralButton	btnFind
private GralButton	btnQuickview
private GralButton	btnWholeword
(package private) boolean	bVisible
private int	cursorPos
private java.nio.charset.Charset	encodingContent
private static byte[]	endl_0a
private static byte[]	endl_0d0a
(package private) FileRemote	file
private char	format The current choiced view format.
private StringFormatter	formatterHex Instance to prepare the text especially for hex view.
(package private) GralMng	gralMng
private static java.nio.charset.Charset	iso8859_1
(package private) LogMessage	log
(package private) int	nrQuickview
private java.nio.ByteBuffer	tmpReadTransmissionBuffer A buffer to get bytes from the file using the java.nio.Channel mechanism.
private byte[]	uContent The gotten bytes from bytebuffer.
(package private) GralTextFieldUser_ifc	userKeys
private static java.nio.charset.Charset	utf8
static java.lang.String	version Version, history and license.
private GralTextBox	widgContent The widget to show content.
private GralTextField	widgFindText
private GralTextBox	widgQuickView
private GralTextField	widgShowInfo
private GralWindow	windView The window of this functionallity.
private int	zContent Number of read bytes.

Fields inherited from class org.vishia.gral.base.GralWidgetBase

_cdata, _wdgPos, bVisibleState, name, pixSize, sVersion

Constructor Summary

Constructors

Constructor and Description
GralViewFileContent(GralPos refPosP, java.lang.String posName)

Method Summary

Modifier and Type	Method and Description
(package private) void	closeQuickView()
boolean	createImplWidget_Gthread() This operation is called to create the implementation widget appearance.
(package private) void	detectEncoding()
GralWidgetBase_ifc	getFocusedWidget() Returns the widget which is in focus of a panel or comprehensive widget.
boolean	isInFocus() Returns true if this widget is the focused one.
boolean	isVisible() Returns whether the widget is visible or not.
(package private) void	openQuickView(FileRemote src)
(package private) void	presentContent()
(package private) void	presentContentHex()
(package private) void	presentContentText(java.nio.charset.Charset charset)
void	quickView() This routine will be called whenever a file is selected newly, it checks quickview.
void	removeImplWidget_Gthread() Removes the implementation widget, maybe to re-create with changed properties or also if the GralWidget itself should be removed.
(package private) void	saveTextAs(java.nio.charset.Charset encoding, byte[] lineEnd)
void	setFocus() Sets the focus to the widget. .
void	setFocus(int delay, int latest)
void	setFocusedWidget(GralWidgetBase_ifc widg) If this widget is a comprehensive widget or a panel, it sets one of the content as focused.
boolean	setVisible(boolean visible) Sets this widget visible on graphic or invisible.
(package private) void	syncContentFromWidg()
(package private) void	syncHexFromWidg()
(package private) void	syncTextFromWidg(java.nio.charset.Charset charset)
(package private) void	view(FileRemote file) Reads the current (last selected) file in the binary content buffer, detects its encoding, shows it.

Methods inherited from class org.vishia.gral.base.GralWidgetBase

checkImplWidgetCreation, createImplWidget, getImplAccess, getName, gralMng, hasFocus, pos, remove, resizePostPreparation, setFocused, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public static final java.lang.String version

Version, history and license. This String is visible in the about info.

• 2022-12-26 Hartmut moved from FcmdView, can be used commonly outside the.File.commander, especially for ordinary file selection and view of its content.
• 2021-02-05 Hartmut chg for FcmdView, change and write in hex. It is under construction yet now. There were no other text editor simply found, which shows characters as hexa, and which allows hexa edit. Hexa changes should be very interesting for experience. Of course not for the common user.
• 2011-10-00 Hartmut created

Copyright/Copyleft:
For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but doesn't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

gralMng

final GralMng gralMng

log

final LogMessage log

windView

private GralWindow windView

The window of this functionallity.

widgContent

private GralTextBox widgContent

The widget to show content.

widgFindText

private GralTextField widgFindText

widgShowInfo

private GralTextField widgShowInfo

btnFind

private GralButton btnFind

btnWholeword

private GralButton btnWholeword

btnCase

private GralButton btnCase

btnQuickview

private GralButton btnQuickview

bVisible

boolean bVisible

bEditable

boolean bEditable

nrQuickview

int nrQuickview

widgQuickView

private GralTextBox widgQuickView

file

FileRemote file

tmpReadTransmissionBuffer

private final java.nio.ByteBuffer tmpReadTransmissionBuffer

A buffer to get bytes from the file using the java.nio.Channel mechanism. The channel mechanism is proper to work with remote file access especially. Note: The ByteBuffer may be a part of the channel mechanism itself, because it is placed JVM-internally, for example for socket communication. TODO check and change it. The size of the byteBuffer is set to less than 1 UDP-telegram payload to support any communication.

zContent

private int zContent

Number of read bytes.

uContent

private final byte[] uContent

The gotten bytes from bytebuffer. This buffer is set to the size of the file, if the file is less than a maximal size.

encodingContent

private java.nio.charset.Charset encodingContent

format

private char format

The current choiced view format.

• a: us-ascii-text
• w: iso (Windows)-text
• u: UTF16-text
• 1: Hexa byte wise
• 2: Hexa 16-bit-words
• 4: Hexa 32-bit-words
• F: contains, float values, shows it

cursorPos

private int cursorPos

ascii7

private static java.nio.charset.Charset ascii7

utf8

private static java.nio.charset.Charset utf8

iso8859_1

private static java.nio.charset.Charset iso8859_1

endl_0a

private static byte[] endl_0a

endl_0d0a

private static byte[] endl_0d0a

formatterHex

private final StringFormatter formatterHex

Instance to prepare the text especially for hex view.

actionQuickView

public GralUserAction actionQuickView

Action for Key crl-Q for quick view command. Its like Norton Commander.

actionFind

GralUserAction actionFind

Action for Key F3 for view command. Its like Norton Commander.

actionOpenView

public GralUserAction actionOpenView

Action for Key F3 for view command. Its like Norton Commander.

actionSetTextViewUTF8

GralUserAction actionSetTextViewUTF8

Action for Key F3 for view command. Its like Norton Commander.

actionSetHexView

GralUserAction actionSetHexView

Action for Key F3 for view command. Its like Norton Commander.

actionSetTextViewISO8859_1

GralUserAction actionSetTextViewISO8859_1

Action for Key F3 for view command. Its like Norton Commander.

actionSetEditable

GralUserAction actionSetEditable

Action for Key F3 for view command. Its like Norton Commander.

actionSave

GralUserAction actionSave

actionSaveTextAsUTF8unix

GralUserAction actionSaveTextAsUTF8unix

actionSaveTextAsWindows

GralUserAction actionSaveTextAsWindows

actionSaveTextAsISO8859_1_unix

GralUserAction actionSaveTextAsISO8859_1_unix

actionOnSetInvisible

GralUserAction actionOnSetInvisible

userKeys

GralTextFieldUser_ifc userKeys

Constructor Detail

GralViewFileContent

public GralViewFileContent(GralPos refPosP,
                           java.lang.String posName)

Method Detail

view

void view(FileRemote file)

Reads the current (last selected) file in the binary content buffer, detects its encoding, shows it. The file is held in a binary content buffer independent of its content type. The hexa view shows the bytes in any case. If the file will be shown as text, either the encoding can be self - detect, or the encoding can be selected by the user. Opens the view window and fills its content.

Parameters:

src - The path which is selected as source. It may be a directory or a file.

quickView

public void quickView()

This routine will be called whenever a file is selected newly, it checks quickview.

detectEncoding

void detectEncoding()

presentContent

void presentContent()
             throws java.io.IOException

Throws:

java.io.IOException

presentContentHex

void presentContentHex()
                throws java.io.IOException

Throws:

java.io.IOException

presentContentText

void presentContentText(java.nio.charset.Charset charset)
                 throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

syncContentFromWidg

void syncContentFromWidg()

syncHexFromWidg

void syncHexFromWidg()

syncTextFromWidg

void syncTextFromWidg(java.nio.charset.Charset charset)

saveTextAs

void saveTextAs(java.nio.charset.Charset encoding,
                byte[] lineEnd)

openQuickView

void openQuickView(FileRemote src)

closeQuickView

void closeQuickView()

setFocus

public void setFocus()

Description copied from interface: GralWidgetBase_ifc

Sets the focus to the widget. . It can be called in any thread. If it is called in the graphic thread, the repaint action is executed immediately in the thread. Elsewhere the graphic thread will be woken up.

setFocus

public void setFocus(int delay,
                     int latest)

isInFocus

public boolean isInFocus()

Description copied from interface: GralWidgetBase_ifc

Returns true if this widget is the focused one.

isVisible

public boolean isVisible()

Description copied from interface: GralWidgetBase_ifc

Returns whether the widget is visible or not. This method can be invoked in any thread. It is an estimation because the state of the widget may be changed in the last time or a window can be covered by another one. The widget is not visible if it is a member of a card in a tabbed panel and that tab is not the selected one.

Specified by:

isVisible in interface GralWidgetBase_ifc

Overrides:

isVisible in class GralWidgetBase

Returns:

true if the widget seams to be visible.

setFocusedWidget

public void setFocusedWidget(GralWidgetBase_ifc widg)

Description copied from interface: GralWidgetBase_ifc

If this widget is a comprehensive widget or a panel, it sets one of the content as focused.

Parameters:

widg - The sub widget which should be focused. It influences for example the current tab of a tabbed panel, or influences which widget of a comprehensive widget is first focused. On a panel it determines which widget should get the focus if the panel gets the focus.

getFocusedWidget

public GralWidgetBase_ifc getFocusedWidget()

Description copied from interface: GralWidgetBase_ifc

Returns the widget which is in focus of a panel or comprehensive widget. This allows quests about the status of the widget, for example the opened tab on a tabbed panel of which is in use currently from a comprehensive widget.

setVisible

public boolean setVisible(boolean visible)

Description copied from interface: GralWidgetBase_ifc

Sets this widget visible on graphic or invisible. Any widget can be visible or not. More as one widgets can use the same position, only one of them may set visible. For a GralWindow, its the visibility of the whole window. Note that a window which is invisible is not shown in the task bar of the operation system. Note that an application can have more as one window. Note that a dialog window can be set to invisible if it is not need yet instead destroy and build newly.

Specified by:

setVisible in interface GralWidgetBase_ifc

Specified by:

setVisible in class GralWidgetBase

Returns:

createImplWidget_Gthread

public boolean createImplWidget_Gthread()
                                 throws java.lang.IllegalStateException

Description copied from class: GralWidgetBase

This operation is called to create the implementation widget appearance. If is either overridden in the specific widget implemented in the GralWidget by the default behavior. Or it should be overridden in instances which are not derived from GralWidget itself, on instances of comprehensive widgets. This implementation is only called in GralWidget.createImplWidget_Gthread() for composite widgets.

Overrides:

createImplWidget_Gthread in class GralWidgetBase

Returns:

true if created.

Throws:

java.lang.IllegalStateException - if called though the GralMng is not implemented.

removeImplWidget_Gthread

public void removeImplWidget_Gthread()

Description copied from class: GralWidgetBase

Removes the implementation widget, maybe to re-create with changed properties or also if the GralWidget itself should be removed. This is a internal operation not intent to use by an application. It is called from the GralMng.runGraphicThread() and hence package private.

Overrides:

removeImplWidget_Gthread in class GralWidgetBase